Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic
 
PerlMonks  

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
For my part I tend to write documentation as I write code :
I wrote a general (abstract) documentation, then I add more detailed parts.
(then I iterate the second phase until satisfied).

Note that you can do it
  • In the same document
    Taking care to put the simple abstract part at the beginning and hiding as much as possible the too specifics details (in an APPENDIX for example)
  • In several documents
    This allow you to specialize your documentation to the reader
    (Beccause a techie don't need the same informations as a commercial...)
The second way is my favourite way, I usually make a (very) small doc describing the product
(just to make the reader understand what we're talking about)
I then write a more detailed document with links to several other (specialized) docs (Appendix, user guide, maintenance guide, sysadmin's guide, developper's guide...).
document.

Last note: 'the quick install' and 'common troubleshooting' parts seems to me the most used part of a technical docs
(at least at my office), it may be worthy to write them with a special care...

UPDATE : The 'links/resources' part is also a must write to my mind...

UPDATE 2: As I realize that my answer may be far from practical, I'll add some common useful guidelines :
  • Write a READABLE way
    Otherwise nobody will (be able to) use it...
  • Adapt your text to your reader (the content AND the form)
  • Don't forget your initial goal
    your technical doc shouldn't become a technical rant about how good the solution is...In the same vein in a commercial documentation, it's totally useless to explain your over-smart technical hack, speak about technological advance ;-)
  • Use spell checkers (It's VERY important for some people (usually your bosses ;-))
  • Use a portable format to allow other people to work on your documentation, convert it...

"Only Bad Coders Code Badly In Perl" (OBC2BIP)

In reply to Re: How to write documentation? by arhuman
in thread How to write documentation? by ajt

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others lurking in the Monastery: (2)
As of 2021-12-05 18:19 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    R or B?



    Results (31 votes). Check out past polls.

    Notices?