TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: Structure for GUI & Command Line Input Doc From:"Mike Starr" <mike -at- writestarr -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 2 May 2002 02:19:47 -0500
I'd probably keep the separate sections and cross-reference them. I think
folks tend to focus on one method as much as possible and keeping them in
separate sections would allow them to use the manual for their primary
methodology without too much noise from the other.
Mike
---
Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Technical Illustrator
Graphic Designer - Desktop Publisher - MS Office Expert
Office: (262) 694-1028 - Pager: (414) 318-9509 - Fax: (262) 697-6334
Home (262) 694-0932 - mike -at- writestarr -dot- com - http://www.writestarr.com
-----------------------Original Message-----------------------
>From: CB Casper [mailto:knowone -at- surfy -dot- net]
>To: TECHWR-L [mailto:techwr-l -at- lists -dot- raycomm -dot- com]
>Date: 5/2/2002 12:22:00 AM
>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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
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
---
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.
