Editorial Guidelines

Content Development

NOTE: This document is not live. It's archive only.

This page contains links to the guiding documents we'll use to assess and adjust the common pages of the opensolaris.org website during the July 2008-July 2009 time period.

Members & Meetings

 Michelle Olson leads the content development effort and conducts all reviews on the public website-discuss mailing list. The following community members have made the effort successful by their contributions: Bill Rushmore, Derek Cicero, Jim Grisanzio, Alan Coopersmith, Alysson Troffer, andrewk8, Artem K., Bonnie Corwin, Bryan Boden, Calum Benson, Danek Duvall, Dan Price, Elijah Wright, Glynn Foster, John Plocher, Peter Tribble, Ronald DeMena, Sean Sprague, Shawn Walker, Simon Phipps, Stephen Hahn, and Steve Lau.

Plan

 The Web Content Plan describes the planned changes and review process for common pages of the opensolaris.org web site.

Roadmap

 The Website Content Roadmap is a guide to the overall activities we'll undertake and accomplish. These activities fall into three main categories: Best Practices guidelines development, Use Case assessment, and Usability Study.

Best Practices

 The Website Best Practices document is a first draft of basic best practices against which, we can begin to assess the common pages for readability. This is just a first draft, but will get us started. As we learn more in the process of updating pages, we can add to the Best Practices those learnings.

Use Cases

 The Website Use Cases document is a first draft of prioritized use cases we should consider for opensolaris.org based on a study completed during the week of June 25, 2007, that explored how developers and leaders of open source projects and communities use web-based tools and sites in support of their work. This set of use cases is just a baseline, the study was informal, but should also give us a good starting place for determining the exact set of use cases on which we should focus our web site content.

Initial Website Use Cases

 This section lists the most important tasks users want to complete on the opensolaris.org web site in priority order.

1. Download code or documentation
2. Search using specific criteria (bugs, keywords, forum topics)
3. Read documentation, release notes & logs
4. Read and post to forums
5. Track issues, report, manage & track bugs
6. Subscribe to mailing lists
7. Track and monitor the industry
8. Contribute/Submit a patch
9. Review source code, sync repo, commit
10. Join project, propose project, find project
11. Look for people based on skills and projects

Usability Study Script

 The Website Usability Script document is a beta draft of twelve specific tasks we should consider for a study of the opensolaris.org website. We're working on a 'screener' that would outline the participants we'd like to find for the study which is an important companion to this script.

Information Architecture

 The Information Architecture document is the alpha draft of a new layout for OpenSolaris.org that could simplify the top-level navigation to 5 categories in a single menu. We could potentially use the 'panels' in Xwiki to provide access points to the subsite zones at subsequent levels. The Site Mockup document is the beta draft of the information architecture that integrates feedback from the alpha Info. Arch. document and learnings from the Xwiki beta implementation.

Presentations

 The draft OpenSolaris.org Web Content Townhall presentation for April 24, 2009.