Re: book freedoms, article structures...
- From: Steve George <steve blah dircon co uk>
- To: gnome-doc-list gnome org
- Subject: Re: book freedoms, article structures...
- Date: Fri, 7 Apr 2000 22:53:00 +0100
Hi,
I think it's worth while thinking 'what is the purpose of my division' whether
that be for a chapter, book or part. The purpose of your parts seems to be to
aggregate some different ways that you might approach the program which makes
sense: the Programming Python book has a similair approach if you want an
example.
As long as you keep the chapters in a part about the same type of approach it
seems sane to me......but then who says I am sane ;-)
Steve
On Wed, Apr 05, 2000 at 08:24:57PM -0400, Aaron Weber wrote:
> 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...)
>
>
> --
> FAQ: Frequently-Asked Questions at http://www.gnome.org/gnomefaq
> To unsubscribe: mail gnome-doc-list-request@gnome.org with
> "unsubscribe" as the Subject.
>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]