Where does documentation go?

Ye' old general discussion board. Basically, for everything that isn't covered elsewhere. Come here to shoot the breeze, shoot your mouth off, or whatever suits your fancy.
This forum is not for asking programming related questions.

Moderator: General Moderators

User avatar
Maugrim_The_Reaper
DevNet Master
Posts: 2704
Joined: Tue Nov 02, 2004 5:43 am
Location: Ireland

Post by Maugrim_The_Reaper »

# Should the auto-generated API documentation be made downloadable?
# Should there be tasteful graphics in tutorial-style documentation? A few pictures can really spruce up a document, at the cost of a few more seconds of download time (I love how A List Apart has an opening graphic for all its articles).
# How important is a PDF download to you?
# Is the pain of compiling docbook worth it? (I currently use HTML)
1. Not unless included in the package already though obviously a download is just a tarball away.
2. Nothing wrong with pictures especially if it breaks up the text only look and feel - some decorative typography is almost as effective.
3. I don't minds so long as the documentation, in whatever format, is printable.
Post Reply