Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change

Re: Writing Good Documentation

by maverick (Curate)
on Jun 24, 2002 at 19:20 UTC ( #176903=note: print w/replies, xml ) Need Help??

in reply to Writing Good Documentation

Take the wisdom of the previous posters :) in addition you could try this technique that I've used before. It does seem to yield better docs (...either that or I just suck at writing :) ).

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.


OmG! They killed tilly! You *bleep*!!

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://176903]
[Corion]: In other RSS news, I've updated my photo stream with images from Lanzarote
[choroba]: Corion Nice
[Corion]: Hi choroba! I'm somewhat fond of this picture - I think it is Breaking Bad-style even though I haven't watched the series at all ;)
[Corion]: Hmmm - and now that I look at it, the gallery I'm using doesn't produce non-Javascript compatible links in the sense that hotlinking to an image will only work for Javascript enabled...

How do I use this? | Other CB clients
Other Users?
Others having an uproarious good time at the Monastery: (5)
As of 2017-02-27 08:30 GMT
Find Nodes?
    Voting Booth?
    Before electricity was invented, what was the Electric Eel called?

    Results (377 votes). Check out past polls.