Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

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

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://519464]
help
Chatterbox?
[choroba]: again a pilot?
[marto]: yeah, the whole infrastructure has changed, and video codecs have moved on a great deal
[Corion]: marto: Redoing something on new infrastructure sounds fun. At least you can reuse your previous experience :)
[marto]: I'm looking forwads to it. The video sources are dying, and they don't have the hardware to play them back (old tape formats, not just VHS + Laserdisc etc)

How do I use this? | Other CB clients
Other Users?
Others taking refuge in the Monastery: (7)
As of 2017-07-28 09:15 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    I came, I saw, I ...
























    Results (425 votes). Check out past polls.