Help Guide Feedback - Was: Etiquette Guide
Aaron Matteson
fedora-docs at cryptosystem.us
Mon Mar 29 07:42:04 UTC 2004
Mike MacCana became daring and sent these 1.0K bytes,
> 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.
>
> Good stuff, its nice and simple. Some feedback:
>
> * 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.
Good idea, will do.
> * I'd mention /usr/share/doc/<packagename>-<version>/ as part of
> your 'Developer Documentation' section.
Also a good idea, will get this section in there in a few days when i
have a day off.
> * 'Developer Documentation' could be taken two ways. Documentation from
> Developers (which I think you mean) and Documentation *for* Developers.
> I'd suggest retitling this section to 'Package Documentation' or just
> 'Documentation'.
I see, hadn't spotted that. I did indeed mean Docs from the developers.
Package Documentation is and does sound a lot more precise.
> Cheers, and thanks for your work.
Thanks for the input and all input to come.
--
0 1 0 Aaron M Matteson - GnuPG:0xD144B7FF
0 0 1 Real programmers don't document. If it was hard to write,
1 1 1 it should be hard to understand!
------------------------------------------------------------------------
http://cryptosystem.us/ - Project
http://cryptosystem.us/blog/ - Blog
http://mindstorm.ath.cx:8080/ - Wiki
More information about the fedora-docs-list
mailing list