Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "COSMOS Document UG template"

(COSMOS User's Guide Outline)
Line 1: Line 1:
 
[[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]]
 
[[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]]
  
'''Audience''': Administrators or other users of COSMOS.
+
{| border="1" cellpadding="2"
 +
!width="50"|Audience
 +
!width="225"|Description
 +
 
 +
|-
 +
|User's || A person who makes use of Eclipse COSMOS project to perform some function including support resources.
 +
|}
  
 
This publication is intended for administrators or other users of COSMOS. It presents an overview of the product and its components. It then provides detailed descriptions of the tasks that you can perform from each component.
 
This publication is intended for administrators or other users of COSMOS. It presents an overview of the product and its components. It then provides detailed descriptions of the tasks that you can perform from each component.

Revision as of 22:16, 7 February 2008

COSMOS Wiki > COSMOS Document Plan

Audience Description
User's A person who makes use of Eclipse COSMOS project to perform some function including support resources.

This publication is intended for administrators or other users of COSMOS. It presents an overview of the product and its components. It then provides detailed descriptions of the tasks that you can perform from each component.

COSMOS User's Guide Outline

  1. Title page
  2. Table of contents
  3. Preface for Legal information
  4. Purpose
  5. Prerequisites
    1. Hardware requirements
    2. Software requirements
    3. Optional add-ons
  6. Overview
    1. Project Objectives
    2. Design description (Scope of document)
    3. COSMOS Components design description
  7. Body of document
    1. What do we need to tell out users?
  8. References
  9. Appendixes
  10. Glossary

Back to the top