Re: book freedoms, article structures...
- From: Eric Baudais <drake x8b4e541f dhcp okstate edu>
- To: Aaron Weber <aaron helixcode com>
- cc: Gnome-Doc-List <gnome-doc-list gnome org>, recipient list not shown:
- Subject: Re: book freedoms, article structures...
- Date: Wed, 5 Apr 2000 21:44:12 -0500 (CDT)
I think the outline is good, but I would divide the usage part further and
have a "Basic Usage" and "Advanced Usage." You might also want to divide
the configuration part into two parts too. I think you should have one or
two parts, depending on amount of information, that are geared to the
advanced/power user. Someone who is comfortable with configuration and
usage of Linux.
Eric Baudais
On Wed, 5 Apr 2000, 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]