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.
Man pages Was RE: Structure for GUI & Command Line Input Doc
Subject:Man pages Was RE: Structure for GUI & Command Line Input Doc From:"Stevenson, Rebecca" <Rebecca -dot- Stevenson -at- workscape -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 3 May 2002 10:02:50 -0400
Coincidentally enough, as this email crossed my threshold yesterday our doc team was approached by engineering and asked if we were planning to distribute our doc in man page form as well as PDF/HTML/cuneiform on brick/anything else they ask us for.
It had never crossed my mind to do this. I don't have the foggiest idea *how* to do this. And yes, I am appropriately ashamed of my UNIX ignorance. Our product is browser-based; it doesn't have a CLI. Does it even make sense for engineering to ask us to provide installation instructions as man pages, and if so, what would be involved in translating our Frame files to this format?
Baffled in Boston,
Rebecca Stevenson
Technical Writer
Workscape, Inc.
508-861-3059
AIM: RJSWriter
-----Original Message-----
From: Sandy Harris [mailto:pashley -at- storm -dot- ca]
Sent: Thursday, May 02, 2002 11:43 AM
To: TECHWR-L
Subject: Re: Structure for GUI & Command Line Input Doc
I'm an old Unix user. For me, question one is whether
the man pages are done. If not, I'd say do them first.
Traditionally, everything on a Unix system -- user
commands, file formats, admin commands, programmers'
libraries, ... -- must have a man page. These are
accessible on-line, printable by the user (also often
provided in book format by the vendor) and have a
cross-reference system.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
