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: Style Guide for UNIX? From:"Susan W Gallagher" <susanwg -at- gmail -dot- com> To:"Julie Stickler" <jstickler -at- gmail -dot- com> Date:Fri, 17 Oct 2008 10:23:56 -0700
Write to your audience, not yourself. Your audience will be comfortable with
a sentence that begins with a lower case letter that they recognize as a
*NIX command, and I'm a firm believer in letting programming (or other
technology based) language trump English where and when necessary.
I used to write about .net a lot -- it gave me a strangely perverted sense
of pleasure to *begin* a sentence with a period!
On Fri, Oct 17, 2008 at 7:51 AM, Julie Stickler <jstickler -at- gmail -dot- com> wrote:
> I've just started a new job and I'll be documenting software that runs
> on UNIX as well as Windows platforms. It's been a long time since I
> did any UNIX back in school, so I've got to get up to speed. I'm
> reading through the Installation guide and I'm noticing a lot of steps
> that start with what I recognize as UNIX commands (cd, untar) so the
> step starts with a lower case letter. This looks odd to me, and I'm
> not sure if this is acceptable when documenting UNIX?
> What say the experts on the list? Is lower case OK, or should I
> rewrite to avoid it? For example, should I edit "cd to the root
> directory." to read "Change directory to the root directory."?
> Can anyone recommend a Style Guide that you use when documenting UNIX
> and Linux? I've usually relied on the Microsoft Manual of Style, but
> well, they're Windows, so they don't cover UNIX issues.
> Julie Stickler
> ComponentOne Doc-To-Help gives you everything you need to author and
> publish quality Help, Web, and print content. Perfect for technical
> authors, developers, and policy writers. Download a FREE trial.
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
> You are currently subscribed to TECHWR-L as susanwg -at- gmail -dot- com -dot-
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
> Please move off-topic discussions to the Chat list, at:
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-