Documentation advice please

[Old Greg]

I'm currently in the process of working out my notice period with a client. I've been requested to document certain processes with the request from a manager to document it in such a way that even he can understand it and carry out the activity.

I've only two weeks to get this done - where should I start?

Do I go for the whole "This is a computer" approach or would I be better off starting from Babbage and cataloging the history of computers from there.

I should also point out that I can use words of more than one syllable, as long as I provide a glossary.

Over to you all .....

You will need two documents: one that he can understand; one that explains how to do the tasks.

[malvolio]

Ever used an IDEF0 flowchart? If so that's how you write it; key activities, inputs, resources, constraints, outputs. What they need is "If I want to do 'this', what buttons do I press in what order?". Don't worry about standard operational processes like Change Management (.." to implement this raise an RFC"...), if they don't know those they're lost anyway.

And make sure you leave your contact details behind...

[MarillionFan]

User manual if it's software.
Glossary or appendices of code
Few Visio of high level process flows

Two weeks worth of work. Kerchiing.

[doodab]

Tell him the dog ate it.

[ctdctd]

On your notice period hey?

I think you will find the only documentation required is your timesheet.

[NotAllThere]

It is a warm summer evening in ancient Greece...

[NickFitz]

Mark some vague woffling up as Javadoc comments, then run it through javadoc. It'll look fairly polished, which they'll mistake for informative. Job done.

[KentPhilip]

Find out who works for him, and assess their level of intelligence and understandability. He'll delegate the reading of your notes to them...

[vetran]

Screen shots!

It's the only way people learn these days

+1

but it is quite expensive in time.

Is it a mutually agreed notice period? Do you want to go back sometime?

pick a few of the simpler & shorter regular routines and do a rough document. get it validated.

This does 2 things
1. gets their approval for the level of documentation
2. sets their expectations for time taken.

[SimonMac]

Screen shots!

It's the only way people learn these days

[woohoo]

I'm currently in the process of working out my notice period with a client. I've been requested to document certain processes with the request from a manager to document it in such a way that even he can understand it and carry out the activity.

I've only two weeks to get this done - where should I start?

Do I go for the whole "This is a computer" approach or would I be better off starting from Babbage and cataloging the history of computers from there.

I should also point out that I can use words of more than one syllable, as long as I provide a glossary.

Over to you all .....

Ask him what level of detail he requires. If he isn't sure provide an example.

Or you could train him on the process and let him document it to a level he requires. If it was me and the process was critical I would want to make sure that I understood it inside out.

[mudskipper]

I'm currently in the process of working out my notice period with a client. I've been requested to document certain processes with the request from a manager to document it in such a way that even he can understand it and carry out the activity.

I've only two weeks to get this done - where should I start?

Do I go for the whole "This is a computer" approach or would I be better off starting from Babbage and cataloging the history of computers from there.

I should also point out that I can use words of more than one syllable, as long as I provide a glossary.

Over to you all .....

Dunno. I keep getting asked to 'document what I've done'. Every time I fail, they renew my contract...

[bless 'em all]

I'm currently in the process of working out my notice period with a client. I've been requested to document certain processes with the request from a manager to document it in such a way that even he can understand it and carry out the activity.

I've only two weeks to get this done - where should I start?

Do I go for the whole "This is a computer" approach or would I be better off starting from Babbage and cataloging the history of computers from there.

I should also point out that I can use words of more than one syllable, as long as I provide a glossary.

Over to you all .....