Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical

Re: creating documentation

by astaines (Curate)
on Dec 28, 2005 at 00:20 UTC ( #519464=note: print w/ replies, xml ) Need Help??

in reply to creating documentation

Important preliminary question - Who are your intended audience?

  • You, and maybe the other core developers e.g. Maple
  • Other programmers using your elegant library or your lovely module e.g. libkdepim or DBI
  • Other people installing your cooooool system e.g. Apache, Slashcode
  • Normal techy people using the software e.g. R
  • Normal non-techy people e.g. OpenOffice

These groups need very different documentation. To produce good documentation you need to know your users. Perhaps the only common thing is that they all need and will benefit from copious annotated examples!

-- Anthony Staines

Comment on Re: creating documentation

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others scrutinizing the Monastery: (5)
As of 2015-11-26 19:59 GMT
Find Nodes?
    Voting Booth?

    What would be the most significant thing to happen if a rope (or wire) tied the Earth and the Moon together?

    Results (706 votes), past polls