book freedoms, article structures...



When one is documenting an application, oh wise ones, 
does it make sense to divide the <book> into <part>s and <chapter>s
by task/component?  This is the way that it seems to me.

My outline for Evolution runs along the lines of

part:usage
chapter:mail
chapter:calendar
chapter:addressbook

part:configuration and cusomization
chapter:preferences
chapter:installing Evolution on multiple machines
chapter:something else

appendix:bugs and troubleshooting
appendix:reference for users of Outlook
appendix:reference for users of Eudora
appendix:how to diagnose appendicitis

a.

(at this point, the troubleshooting parts say "jump up & down a few
times.  this usually works for me...)



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]