[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Structure for GUI & Command Line Input Doc

Subject: Re: Structure for GUI & Command Line Input Doc
From: Bruce Byfield <bbyfield -at- axionet -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 02 May 2002 09:17:19 -0300


CB Casper wrote:

I am contemplating combining these two chapters
to emphasize the commands and actions rather than
the means to accomplish the task. I want to focus
on what the user is trying to do, rather than how
they accomplish it.

I was in much the same position when I did a Linux manual. Although there were some chapters to orient users to the desktop and command line, most of the manual was organized by tasks.
This was how I organized sections: First, the top level heading,would explain any concepts or background necessary for the task. For example, under "Changing Permissions," I would explain what permissions were and why and how to use them.

Then I would have detailed procedures, such as "Changing permissions from the command line" and "Changing permissions from the desktop" beneath that.


Users seemed pretty pleased with the organization. However, you can judge for yourself at http://www.debian.org/doc/manuals/users-guide/.

--
Bruce Byfield 604.421.7177 bbyfield -at- axionet -dot- com

"'What happened to the Spaniards
That made so great a boast-o?
They shall eat the feathered goose quill,
We shall eat the roast-o."
- Traditional, Halston Furey Dance




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com

Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


References:
Structure for GUI & Command Line Input Doc: From: CB Casper

Previous by Author: Re: Study: Internet Explorer Dominates the Web
Next by Author: Re: Contracting question
Previous by Thread: Structure for GUI & Command Line Input Doc
Next by Thread: Re: Structure for GUI & Command Line Input Doc

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

What this post helpful? Share it with friends and colleagues:

Sponsored Ads