Beefy Boxes and Bandwidth Generously Provided by pair Networks
XP is just a number
 
PerlMonks  

Re: Re: Writing Good Documentation

by rattusillegitimus (Friar)
on Jun 24, 2002 at 19:22 UTC ( #176905=note: print w/replies, xml ) Need Help??


in reply to Re: Writing Good Documentation
in thread Writing Good Documentation

  • Get reviews, just like code reviews.

This is one of the best ways to be sure your documentation will properly reach its audience. In my experience, it's been best to have at least one person not directly associated with the project review the docs, if possible. Sometimes that's the only way I've realized that one of my assumptions about How The Universe Works is neither common knowledge nor an immutable law of physics. ;)

-rattus

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://176905]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others wandering the Monastery: (7)
As of 2021-04-14 20:52 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?