Beefy Boxes and Bandwidth Generously Provided by pair Networks
laziness, impatience, and hubris
 
PerlMonks  

Re: How to lay out POD documentation for multi-faceted apps

by Anonymous Monk
on Apr 03, 2017 at 03:52 UTC ( [id://1186764]=note: print w/replies, xml ) Need Help??


in reply to How to lay out POD documentation for multi-faceted apps

Hi,

Link the documentation overview document in the description of every app/module/doc...

Also add the link in the "SEE ALSO" section

  • Comment on Re: How to lay out POD documentation for multi-faceted apps

Replies are listed 'Best First'.
Re^2: How to lay out POD documentation for multi-faceted apps
by stevieb (Canon) on Apr 03, 2017 at 21:48 UTC

    Thanks anonymonk. I think I will do this. I did this in a way for another project, but not precisely.

    I like the idea of having an overview type doc, perhaps named something obvious like "README_FIRST" or the like, so that when people arrive at the page on the CPAN, it will be an obvious first choice, unless they know exactly what module/binary they are looking for. Then any FAQ/Tutorial doc stands out as well, but not before the main overview doc of docs (in the case I presented, the FAQ focuses only on specific aspects of the distribution... I should change that up with additions on all aspects of the dist as well while I'm at it).

    I appreciate the feedback.

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others sharing their wisdom with the Monastery: (4)
As of 2024-04-23 07:33 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found