Help Guide Feedback - Was: Etiquette Guide

Joshua Daniel Franklin joshuadfranklin at yahoo.com
Mon Mar 29 04:53:17 UTC 2004


--- Mike MacCana <mikem at cyber.com.au> wrote:
> On Sat, 27 Mar 2004, Aaron Matteson wrote:
> 
> > What i am posting about it a request for feedback on what i have done so
> > far, i would hate to complete it and realize that i did it wrong.
> > Pointers would also be gratefully accepted.
> 
> * A thought: maybe replace 'man' with 'info'. Info documentation is often
> better maintained than man pages, and if you type 'info' and there's no
> info page, it'll fall back to using the man page - so users get the best
> available.

I actually wrote a short article covering the differences between
the two a while ago:

<http://iocc.com/~joshua/misc/maninfo.html>

You have full permission to take anything useful from there, verbatim
or otherwise. I'd also recommend 'pinfo' over the standalone 'info' 
reader. I actually think 'man' would have disappeared by now if 'info' was
at all intuitive to use (and all programs had good --help output 
for quick checking). If you encourage people to use 'info' they'll either 
give up or eventually find 'pinfo'.

 
> * I'd mention /usr/share/doc/<packagename>-<version>/ as part of
> your 'Developer Documentation' section.

Big plus for this one, too.

Also, why not link to ESR's "Smart Questions" itself with ulink?

There are some minor grammatical issues (like captitalizing "I")
that I assume you're already planning on fixing. :)

__________________________________
Do you Yahoo!?
Yahoo! Finance Tax Center - File online. File on time.
http://taxes.yahoo.com/filing.html





More information about the fedora-docs-list mailing list