in reply to Writing Good Documentation
If I wrote the program, I understand it. Granted I can try my best to put myself in the shoes of another and write the docs occordingly. But let's face it...there's no substitute for having someone else (who has not been involved with the project) read your docs and try to follow them to install/configure/use the program.
When they hit a snag, explain to them what to do and have *them* update the docs. Odds are it will be more thorough and clearer than the update you would have made.
HTH
/\/\averick
OmG! They killed tilly! You *bleep*!!
|
---|