Re: 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.	[reply]

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.

[reply]