openoffice-doc mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ricardo Berlasso <rgb.m...@gmail.com>
Subject Re: New Doc Volunteer
Date Tue, 24 Sep 2013 16:44:17 GMT
2013/9/23 Andy Walton <projects@andywalton.net>

> Hi, Mailing List!
>
> I've just signed up for the documentation mailing list / added my name to
> the wiki lists and I wanted to introduce myself. I'm Andy and I'm a
> freelance technical writer based in Leicester, UK. My background is in
> user-facing documentation such as manuals and how-to content, but I'm
> looking to gain some more experience of creating developer docs and working
> on big projects (such as this one!) I'm very much looking forward to
> working on OpenOffice.
>

Welcome!

Your experience will be a great help for the project!

The user documentation is being worked on the wiki, so you need to get an
account. For more  details, see this page

http://openoffice.apache.org/orientation/intro-doc.html

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 last 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,
Ricardo



>
> Thanks,
>
> Andy
>
> ------------------------------**------------------------------**---------
> To unsubscribe, e-mail: doc-unsubscribe@openoffice.**apache.org<doc-unsubscribe@openoffice.apache.org>
> For additional commands, e-mail: doc-help@openoffice.apache.org
>
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message