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: UNIX and Windows documentation From:"William H Turner" <turnerw -at- us -dot- ibm -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 3 Apr 2002 09:08:30 -0800
Ted,
I agree with the comments of Sue Gallagher and Bruce Byfield regarding
tuning the doc to the Windows audience and assuming that the UNIX audience
can adjust better. I do that in my current book even though the primary
console runs Linux.
I think Sue Gallagher also suggested generalizing, which I do in describing
UI elements. For example, a Windows combo box is a scrollable list on
Linux, so I just call it a "list" while showing a Windows screenshot.
Some UI elements differ so much between UNIX and Windows that I have a
section that describes those differences. Then, wherever the book mentions
one of those diverging UI elements, I cross-reference to that descriptive
section.
--Will Turner
IBM Information Development Dept. G26A
turnerw -at- us -dot- ibm -dot- com
Building 51/2B47
5600 Cottle Rd.
San Jose, Ca. 95193
internal: 69886; TIE: 8/276-9886
outside: (408) 256-9886
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
