Re: Style Guide for UNIX?

["Chris Morton" <salt -dot- morton -at- gmail -dot- com>]

When I documented UNIX software installation at HP, I would have a numbered
step, with some prose, set in Arial. Immediately below and indented a bit,
I'd show the actual command in Courier New, some variant of Courier being
most often used to depict actual user input or code.

So....

4) Change directory to /gimfratz/frabulator.

         cd /gimfratz/frabulator

> Chris


On Fri, Oct 17, 2008 at 8:47 AM, Julie Stickler <jstickler -at- gmail -dot- com> wrote

> I checked out Read Me First on Amazon, and it doesn't have UNIX listed
> in either the TOC or the Index, so I'm not sure that it would be much
> help.
>
> Chris, thanks for the reminder that UNIX is case sensitive.  I knew
> that, but now I have to go back to the doc that I'm editing and mark
> where the writer capitalized commands incorrectly.
>
> Fred, Paul, thanks for the rewrite suggestions!  Very helpful!
>  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 salt -dot- morton -at- gmail -dot- com -dot- 
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> http://lists.techwr-l.com/mailman/options/techwr-l/salt.morton%40gmail.com
>
>
> 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:
> http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat