Steven Vollmer wrote:
I proofread my first entry in the user guide section for Tables.

I'm not exactly sure if this is the right place to start this
discussion. I'm going to give this a shot. Feedback on my
contribution is welcome.

This is always a good place to start a discussion on anything having to do with AOO documentation.


I still need to check the entry for accuracy with the style guide
after I review it closer. I completed the edit for grammar, spelling
and punctuation.

Your changes look good to me. We have rolled-up style guide checking as part of the overall proofreading. What many have found useful in the past is to do the proofread in 2 passes. The grammar and spelling in one pass, and the style elements in a second pass. The accuracy check is open the guide in one window and a blank AOO document of the type the guide is referencing in another. Then follow the steps n the guide and see the program matches what the guide is saying to do. So for tables you would open the table guide in a window and open a blank Writer document in another. You would then follow the steps in the guide and make sure that they accurately define the procedure.

We have split the accuracy check into two parts. One done with the current release version 3.4.1 and a second with with version 4.0.0 which these guides are primarily aimed at. The reason is that Version 4 is still in development and subject to change daily. By checking it against 3.4.1 we should hopefully catch a potential problems early.

In Documentation/UserGuide/Writer/Intro/Tables, I wasn't sure what
the very last line meant. ("...it is enough to edit the text present
there.") Maybe it should be re-worded to be clear?


If you cannot understand it than it probably needs to be re-worded. The goal is to have the documentation as clear as possible.

Regards
Keith

Thank you, Steve





________________________________ From: Keith N. McKenna
<keith.mcke...@comcast.net> To:
doc@openoffice.apache.org Sent: Saturday,
March 23, 2013 12:55 AM Subject: Re: Completed Introduction to
Documentation

Steven Vollmer wrote:
Finished!
Congratulations and welcome to the documentation group. Currently we
are working on the User Guides for AOO version 4.0. These are bing
done on the mwiki and can be found at
http://wiki.openoffice.org/wiki/Documentation/UserGuide. At the
bottom of that page there is a link to the Status Page that we use to
track what has been done.

The easiest way to start contributing is to go to the status page and
find an entry that has not been either proofread or checked for
accuracy and add your name as a reviewer and what you are going to
do.

For proofreading look at spelling, grammar, are headings at level 2
(shown as == Heading ==), are subheadings at level 3 (shown as ===
Heading ===), and other ites from the style guide at
http://wiki.openoffice.org/wiki/Documentation/Dashboard/Help_Style_Guide#Formats

 As always any questions send a note to the list.

Regards Keith


---------------------------------------------------------------------


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




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

Reply via email to