On 08/21/10 08:45, Jennifer Gutsche wrote:
Thank you, Clayton. This is very helpful. I'm going to start with the FAQs while I get my bearings.

As for using the corrected FAQs as an example, that brings up another question. Is there a style guide, or is writing documentation for OOo mostly intuitive?

There is a general style guide for Wiki editing -

http://wiki.services.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy

It's just a guideline, not a set of fixed rules.

Some other general Wiki resources:
http://wiki.services.openoffice.org/wiki/Help:Page_naming
http://wiki.services.openoffice.org/wiki/Help:Editing

Generally, editing in the Wiki is fairly easy. The syntax is simple, and there is the optional WYSIWYG editor you can use as well. Any changes you make are always reversible, so.. don't be afraid to try something (you can use the preview page button if you're trying out ideas). Generally if you're working on a section of the docs, pick another page that is similar and is marked as accurate (like in the FAQ examples I gave you). That will give you an idea of how the layout works, and the style we picked for that doc type.

If you think of a better way to do things, speak up. The Wiki is always evolving, and we are always bumping into new/better ways to do things.

If you get stuck, just ask. There are a few us us around here that have gotten to be pretty good at making the Wiki do interesting tricks :-)

C.
--
Clayton Cornell       [email protected]
OpenOffice.org Documentation Project co-lead

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to