RE: Structure for GUI & Command Line Input Doc

[Matthew Horn <mhorn -at- macromedia -dot- com>]

CB asked:

>>Currently there are separate chapters for GUI & CLI, and am questioning the wisdom of this 
>>practice.

I would combine the two sections, and separate the sections by functionality, not interface, as you had hinted at. This focuses the book on tasks rather than environments, and also prevents duplicated information. With rapidly changing products, duplicate information can get out of sync very quickly.  

Whenever you document a task that has both a CLI and a GUI, just add an additional part to the step. For example:

<H1>Restarting the server
    To restart the server:
    1. Click restart on the Server Console

       or

       Enter the following command at the command line:
       %> jrun myapp -restart
    2. ...
    3. ...

We have a Java-based application server which is both Windows AND Unix-based. On both OS's, you have a CLI in addition to GUI for some admin tasks. The administration console which contains most of the functionality is Web based so it is the same for both OSs. The only sections we separated are the installation sections, which are entirely different. 

Another problem is that we have executable JAR files with the application. They can be executed in a Windows environment by double-clicking on them or in a Unix AND Windows environment from the command line. The solution here is to include a Windows only step:

<H1>Launching the connector
    To launch the connector:
    1. Enter the following at the command line:
       %> java -jar jrun_root/bin/jrun.jar -option1 option2

       or

       (Windows only) Double click the jrun.jar file.
    2. ...
    3. ...

We recognize that most people don't want to use a CLI if at all possible.


-----Original Message-----
From: CB Casper [mailto:knowone -at- surfy -dot- net]
Sent: Wednesday, May 01, 2002 2:46 PM
To: TECHWR-L
Subject: Structure for GUI & Command Line Input Doc



I have inherited a user manual for a product that
includes both a GUI and a Command Line Interface
to configure the software/hardware on Unix.

Currently there are separate chapters for GUI &
CLI, and am questioning the wisdom of this practice.

Recognizing that some commands are not available
through the GUI, yet a lot of the information is
duplicated in both chapters.

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.

It makes sense to me anyway. If I want to accomplish
a certain task, I need to know WHAT command & options
to use. Secondarily, I then need to know HOW to do it.

Any real world examples or experience would be 
appreciated, along with thoughts on this.

I think along the same lines at the local video store.
Combine the videos and DVDs together. What I want is
a movie, the format is secondary, since I have both.
Besides, for people who only have video, they never
go to the DVD section, and will never know what they
are missing.

CB


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.