Community archive

Ask something
Discussion Locked

Documentation

0 helpful
1 reply

by malo r

Closed to new repliesThis discussion is closed. It stays readable, but it takes no new replies.

I know I'm as guilty as the next guy. I don't document enough and when I do it's on a piece of paper that ends up being put up on a shelf...sowewhere, but I want to change that. I want to take all my notes and make them into something that is well organized. Not some paper pile that takes hours to search through.
I want to know how others have organized the documentation at their sites.
Thanks

1 reply

by generalist

Certain aspects of the documentation can be installed as 'Help' text. You might try for a couple of different levels of 'Help' text.

One level will be the 'How To' section. This will help the end user figure out how to do things.

Things at this level could then be linked to a 'Why do we do it this way' section that explains the background of the specific tasks. Too often the reasons for doing something are lost due to lack of documentation or personnel loss.

An 'Overview' section, with annotated parts, could be used to handle the rest of the documentation. Note that the Overview section might include something of the history of the system, especially when processes change how things are done.

Of course, all of the above maybe too much work.

This discussion is closed to new replies.