Information, Transmission, Modulation, and Blog
    RSS        OpenSolaris: Innovation Matters
Who?
Richard Friedman is a senior staff information engineer who documents the Sun Studio compilers and contributes to the Sun Studio portal at developers.sun.com.
rchrd wrote his first computer program in FORTRANSIT on the IBM 650 in 1962.
He also is a photographer and has a life and a radio program.
Email to rchrd at sun.com
Where Else?

»All I Know::
Information, Transmission, Modulation, and Noise

»MUSIC FROM OTHER MINDS on KALW-FM

»All I've Seen :: photo blog

Elsewhere?
»Sun Studio Developer's Portal
»Solaris Developer Blog
Search
Lijit Search
Recent Entries:

Complete Archives

Menu

XML
Site Meter

Thursday December 13, 2007 20071213

• A Good Model for a Community Docs Project

Not only does OpenOffice look like a really viable authoring environment for community-developed, open source user documentation, it comes with an already-functioning doc writing community that can serve as a model for many others.

I've spent some time looking at the OOoAuthors.org site, and there's a lot of really good stuff here, stuff I plan to adopt as I try to set up a user docs community at Open-MPI.org.

Their website has a number of writing guides and a basic chapter template that seem quite reasonable and could apply to a number of open documentation projects, at least as a starting point.

For example: (these are OpenOffice .odt documents)

The chapter template that they use for all their documentation is a simple .odt file that we can probably adopt without much change. There are additional resources pages.

Another valuable use of the oooauthors.org site is that it outlines the procedures they use to develop, review, and publish their user documentation. See their Contribute page. 

A first step would be for everyone to get started with Open Office.

 I'd be interested to hear from anyone who is currently using OpenOffice as their authoring environment in a community, open source, documentation project. Comment, please...



( Dec 13 2007, 02:47:00 PM PST ) [Technical Writing] Permalink

Comments:

Post a Comment:

Comments are closed for this entry.