Introduction

[Owen Morrill <o....@aggiemail.usu.edu>]

Hello,

I'm a technical writer out of Colorado, and I'm looking into doing more
software documentation. I'm not quite sure where to start with all of this,
but I'm looking through the orientation modules and playing on the wiki.

Thanks,
-- 
-Owen Morrill
(202) 669-8103
LinkedIn: omorrill <http://www.linkedin.com/in/omorrill>
Twitter: @OMorrill <https://twitter.com/OMorrill>

Re: Introduction

["Keith N. McKenna" <ke...@comcast.net>]

Owen Morrill wrote:
> Hello,
>
> I'm a technical writer out of Colorado, and I'm looking into doing more
> software documentation. I'm not quite sure where to start with all of this,
> but I'm looking through the orientation modules and playing on the wiki.
>
> Thanks,
>
Greetings Owen;

Your experience will be a great help for the project! The draft for the 
4.0 user guide is growing here: 
http://wiki.openoffice.org/wiki/Documentation/UserGuide (there is a link 
to the "status page" at the end).

There are several missing pages and holes on the existing ones, but an 
easy start would be to proofread the existing pages and check the 
information for "accuracy". Note that this guide is aimed to AOO 4.0, so 
you need the latest version to check the guide.

Clearly, writing an user guide implies not only writing skills but also 
knowledge of the software: if you have any doubt about how Apache 
OpenOffice works, just ask!
So the "tasks" available are many, some of them already mentioned:
   ● Check spelling and grammar for existing pages (proofreading)
   ● Check if it is possible to reproduce what the  guide suggest, i.e., 
if topics are clearly explained (accuracy and "understandability")
   ● Write new material It is also possible to add
   ● User Guide "design": to make the user guide more visually 
"appealing" to the readers.

We use this mailing list to discuss the changes. In general we can say 
that the approach is
   ● small changes like fixing typos and formatting errors: just do it!
   ● new material: just announce it! Both at the beginning of your work 
and when you are done.
   ● big changes like moving sections or rewriting existing material: 
discuss first on the list!

  Tester, editor or writer? You choose

  Regards

Keith


---------------------------------------------------------------------
To unsubscribe, e-mail: doc-unsubscribe@openoffice.apache.org
For additional commands, e-mail: doc-help@openoffice.apache.org