Re: Style Guide for UNIX?

[beelia <beelia -at- gmail -dot- com>]

I worked at Sun for many years, and I understand you work there now.
I'm sure Solaris is second nature to you, and you understand exactly what
you're doing when you write a command line procedure. You've probably not
only walked through those procedures, but corrected them or filed bugs when
they don't work as the engineer intended.

However, I've worked with many writers who are unfamiliar with UNIX
commands, and I've had to review and correct their documents. UNIX isn't
intuitive, and if you "sort of" have an idea of what it means, it's not the
same as knowing what it means.

So my comment was just cautionary. It's relevant especially if you're
unfamiliar to the point that you don't know about its case-sensitivity. My
message was - when you write up a UNIX procedure, be careful to either get
it right on your own, or consult your SME before you change the smallest
thing.

Bee


On Sat, Oct 18, 2008 at 4:55 PM, Janice Gelb <Janice -dot- Gelb -at- sun -dot- com> wrote:

> beelia wrote:
> > The bottom line is - if you can't understand and walk through the
> > procedure yourself, don't creatively edit anything the engineers give
> you.
> >
>
> Sorry, but I'm not sure I understand how this
> point is relevant to the discussion of whether
> to try to avoid starting a sentence with a lower-
> case computer term, or whether to avoid using
> commands as verbs in a sentence.
>
> -- Janice
>
> ***********************************************************
> Janice Gelb          | The only connection Sun has with
> janice -dot- gelb -at- sun -dot- com  | this message is the return address
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
> solution. Author in Doc-To-Help's XML-based editor,  Microsoft Word or
> HTML and publish to the Web, Help systems or printed manuals.
> http://www.doctohelp.com
>
> 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 beelia -at- pacbell -dot- net -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/beelia%40pacbell.net
>
>
> 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 2009 is your all-in-one authoring and publishing 
solution. Author in Doc-To-Help's XML-based editor,  Microsoft Word or 
HTML and publish to the Web, Help systems or printed manuals. 
http://www.doctohelp.com

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