OpenSolaris

Roadmap for OpenSolaris Feature Documentation

Launch

June, 2005

Phase 1

June, 2006

Phase 2

December 31, 2006

Phase 3

March 31, 2007

Phase 4

TBD

Web presence that includes introductory documentation process

Develop and publish “How To” Contribute to OS docs for Website. Must include standards for acceptance of contributions to OpenSolaris feature documentation.

Complete preparation of pilot list of man page source for release to OpenSolaris

Complete preparation of 75% of all man page source files.

Open source all feature documentation. Open source all man pages;

Email list started (alias)

Prepare man page source for release to OpenSolaris

Prepare man page consolidation checklist for review by OpenSolaris P-team

Complete appendices to man page consolidation for 75% of all man pages.

DocBook or other standard used to author

Communicate with community by means of Sponsors.

Publish Man Page content Guidelines for website. Develop OpenSolaris StyleGuide for website

Prepare scripts for creating man page source tarball. Prepare man page README file for inclusion in tarball

Engage in first-date with tools community to determine path for gate split and SCM migration for man pages.

Docs fully available to community to reuse and republish and visa versa

Accept feedback on Solaris documentation. Accept ASCII contributions.

Begin program of University recruitment and evangelism, develop curriculum guide for SIGSCE

Develop web pages for man page consolidation download center and incorporate OpenGrok functionality

Audit and outreach to Projects with draft man pages on OpenSolaris.org.

Source Control, Archive, fully accessible to community

Sponsors and writers use bugs.opensolaris.org to expose old bugs and RFEs to the community and to capture bug and rfe input from the community.

Point to DocBook User Guide or other SGML User Guide from Website

Update curriculum guide, reformat student guide as hard copy mini-book

Outreach to community distros to ensure man page inclusion.

Sponsors might include external as well as internal persons

Pointers to current Solaris documents, including Global Glossary

Develop Big Doc List for OpenSolaris website

Sponsors working directly with community in doc development (writing, editing, tagging, consultant)

Man page writers working with engineering Sponsors in man page development (writing, editing, tagging, consultant)

Open publication model

Engage G11n in discussions

Develop prototype for landing page for OpenSolaris documentation project

Work with G11N to translate student guide and Starter Kit content

Outreach for translated man page needs and contributions.

Roadmap published

Work with G11N on community building through Global Glossary translation project.

Work with OpenSolaris team to implement aggregator for blogs within OpenSolaris documentation

Begin development of new or modification of existing nroff style guidelines.

Identify resources needed to continue going forward, dependencies and adjust milestones

Develop SGML templates. Deliver documentation sources to OpenSolaris. Sponsors able to accept DocBook or standards compliant contributions. Assess and Adjust.

Deliver pilot man page sources to OpenSolaris; modifications and new pages by means of a sponsor. Pages available for reuse, repackage, redistribution. Assess and Adjust.

Deliver 75% of man page sources to OpenSolaris. Assess and Adjust.

Assess and Adjust