openoffice-doc mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From RGB ES <rgb.m...@gmail.com>
Subject Re: Introduction
Date Thu, 27 Jun 2013 16:57:07 GMT
2013/6/27 Natasha Selvey <nyselvey@gmail.com>

> I have been looking through the existing drafts in
> http://wiki.openoffice.org/wiki/Documentation/UserGuide and I would
> like to ask a few clarifying questions...
>
> It appears that a lot of content is missing/not yet created.
> I am making the assumption that this guide will (eventually) be
> comprehensive to all functions in the OpenOffice components?
>

That was the idea! In a sense, you can see the existing pages as a sort of
"skeleton" for a comprehensive user guide. I wrote those pages to provide a
starting point from which build the whole guide, following a structure
previously discussed.

The missing parts are of two categories:

- short and easy to write subsections that I left behind for a moment (that
ended being too long...) to put together the most important and difficult
topics first
- topics that I do not know/understand

Several of those missing topics are already indicated either on the
different pages or on the status page, but other topics are "really
missing" like working with forms on Writer, mail merge, use of general
databases...


>
> I was looking at the current articles in the Writer guide and I think
> the sections could be better organized. Am I free to make such a
> change, or is this something that is better discussed first? I
> apologize if this is a non-issue, being new to this process I want to
> make sure I understand what is acceptable.
>

If the change is small, just do it!, but for greater changes (splitting or
merging pages, moving around big sections) maybe it's better to briefly
discuss and coordinate the changes first.


>
> Thank you for the input.
>

Thanks to you for your help! The changes you already did on the "User
interface" section are really good!

Regards
Ricardo



>
> Natasha Selvey
>
> On Thu, Jun 20, 2013 at 9:08 AM, RGB ES <rgb.mldc@gmail.com> wrote:
> > Welcome, Natasha!
> >
> > More comments below
> >
> > 2013/6/20 Natasha Selvey <nyselvey@gmail.com>
> >
> >> Hello,
> >>
> >> My name is Natasha Selvey and I would like to get involved in
> >> documentation at OpenOffice. I have a background in Document
> >> Control/Quality Systems but I enjoy writing technical documents. I am
> >> also currently learning Java, Python, HTML, CSS, and Javascript.
> >>
> >> I already read through the orientation modules and signed up for MWiki
> >> and CWiki. I would really appreciate some direction for helping out
> >> with documentation.
> >>
> >
> > Perfect!
> >
> > At the moment, the user documentation is being worked on the wiki. Please
> > look at where the draft for the 4.0 user guide is growing:
> >
> > 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".
> Most
> > of the material there was written by a non native English speaker
> (me...),
> > so the actual text needs a lot of attention.
> >
> > Clearly, writing an user guide implies not only writing skills but also
> > knowledge of the software: if you have doubts about how Apache OpenOffice
> > works, just ask!
> >
> > Note that this guide is aimed to AOO 4.0, so there are instructions on
> the
> > guide that do not completely correspond to the stable builds (like "menu
> > Tools → Options → Apache OpenOffice": on 3.4.1 you'll find
> "OpenOffice.org"
> > there). You can find development builds for 4.0 here:
> >
> >
> https://cwiki.apache.org/confluence/display/OOOUSERS/Development+Snapshot+Builds#DevelopmentSnapshotBuilds-AOOSnapshotfullsets
> >
> > 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.
> >
> > Tester, editor or writer? You choose :)
> >
> > Regards
> > Ricardo
> >
> >
> >>
> >> -Natasha Selvey
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: doc-unsubscribe@openoffice.apache.org
> >> For additional commands, e-mail: doc-help@openoffice.apache.org
> >>
> >>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: 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