DocPlanning

From Genunix

Jump to: navigation, search

Contents

Doc Plan

This document describes the plan for documentation development.

Revision History

First draft August 7th, 2009, Michelle Olson

Goals

Streamline 17 docs into 4: Install, Service, Admin, and License.

Update the remaining four docs for new features, consistency, and voice.

Doc Review Schedule

Task Who Start Finish

Note: Use mediawiki notifications, staging wiki, categories, and RSS to manage.

Summary of Doc Set

Currently, the complete documentation set includes 17 separate documents. The short-term goal is to streamline the set down to four documents and edit them for consistent tone, voice, architecture and terminology.

New and Updated Functionality for September

BUI

CLI

Install

Service

Admin

Release Notes?

New User Tasks

Function Doc Updates New or Updated

Updated User Tasks

Function Doc Updates New or Updated

Pre-publishing Tasks

Versioning (part number dash roll, Linking Indexing Navigation Examples Screenshots Visual Inspections SME sign-off


Audience Analysis

Main audience is experienced system administrators. Administrators of SS7000 might perform all of the tasks available in the application.

Contacts

Personal tools