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 Schedule"

(→‎COSMOS Document Schedule for GA)
(→‎COSMOS Logging and Messaging Guide)
 
(48 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
=== Documents ===
 
=== Documents ===
−
There will be two documents:
+
There will be three documents:
 
* COSMOS User's Guide
 
* COSMOS User's Guide
 
* COSMOS Developer's Guide
 
* COSMOS Developer's Guide
 +
* COSMOS Installation Guide
 +
* COSMOS API Document
  
 
=== Availablility ===
 
=== Availablility ===
Line 13: Line 15:
 
The development of a document consists the following chronological milestones.
 
The development of a document consists the following chronological milestones.
  
 +
# Outline draft of development contents on Wiki
 +
# Devlopment content available to writer
 
# First draft
 
# First draft
 
# Review
 
# Review
−
# Second draft
+
# Second and final draft (PDF and online helps)
 
# Review
 
# Review
−
# Final version distributed to reviewers
+
# Approval copy
−
# Approval
+
# Create PDFs 
−
# Create PDF and online helps
+
# Provide online helps
−
# Test online helps
+
 
−
+
== COSMOS Documentation Schedule for GA ==
−
== COSMOS Document Schedule for GA ==
+
 
 +
 
  
 
=== COSMOS User's Guide ===
 
=== COSMOS User's Guide ===
 +
The COSMOS User's Guide will be available as HTML, PDF and online help.
  
 
{| border="1"
 
{| border="1"
Line 33: Line 39:
 
! Activity
 
! Activity
 
! Duration
 
! Duration
−
 
 
! Projected Date
 
! Projected Date
−
 
+
! Comments
  
 
|-
 
|-
  
−
| First draft
+
| Development outline
 
| n/a
 
| n/a
−
| 03/12/08
+
| '''02/22/08'''
 +
| Provide an outline of your content on the Wiki
 
|-
 
|-
−
| First review
+
| Development input
−
| 5 days
+
| n/a
−
| 03/19/08
+
| '''04/01/08'''
−
 
+
| Completed information provided to writer
 +
 
|-
 
|-
  
−
| Second draft
+
| First draft/edit
 
| _
 
| _
−
| 04/09/08
+
| 04/16/08
 +
| PDF file provided for markup and online help plugin
 
|-
 
|-
−
| Second review
+
| First review
 
| 5 days
 
| 5 days
−
| o4/16/08
+
| 04/22/08
−
 
+
| Send marked up PDF to writer
 +
 
|-
 
|-
  
−
| Final edited draft
+
| Second document draft
 +
 
| _  
 
| _  
−
| 05/21/08
+
| 05/12/08
−
 
+
| PDF file for last review
 +
 
 
|-
 
|-
−
| Approval version
+
| Final review
−
| n/a
+
−
| 06/02/08
+
−
|-
+
−
| HTML Helps version
+
 
| 5 days
 
| 5 days
 +
| 05/19/08
 +
| Send marked up PDF to writer
 +
|-
 +
| Approval
 +
| _
 
| 06/04/08
 
| 06/04/08
 +
| Signed approval
  
 +
|-
 +
| HTML Helps version
 +
| _
 +
| 06/09/08
 +
| Provide online help files
  
−
|}
 
  
 +
|}
  
 
=== COSMOS Development Guide ===
 
=== COSMOS Development Guide ===
−
 
+
The COSMOS Development Guide will be available as HTML on the development server only. Online helps will not be provided for first release.
 
{| border="1"
 
{| border="1"
  
Line 85: Line 103:
 
! Activity
 
! Activity
 
! Duration
 
! Duration
−
 
 
! Projected Date
 
! Projected Date
 +
! Comments
  
 
|-
 
|-
  
−
| Content Complete
+
| Development outline
 
| n/a
 
| n/a
−
| 03/12/08
+
| '''02/28/08'''
 +
| Provide an outline of your content on the Wiki
 
|-
 
|-
−
| -
 
−
| -
 
−
| -
 
−
 
  
 +
| Development input
 +
| n/a
 +
| '''04/22/08'''
 +
| Completed information provided to writer
 +
 
|-
 
|-
  
 
| First draft
 
| First draft
−
| n/a
+
| _
−
| 04/09/08
+
| 05/13/08
 +
| PDF file provided for markup
 
|-
 
|-
 
| First review
 
| First review
 
| 5 days
 
| 5 days
−
| 04/16/08
+
| 05/17/08
 +
| Send marked up PDF to writer
  
 
|-
 
|-
  
−
| Second draft
+
| Second document draft
−
| _
+
| _  
−
| 05/07/08
+
| 06/06/08
 +
| PDF file for last review
 +
 
 +
 
 
|-
 
|-
 
| Final review
 
| Final review
 
| 5 days
 
| 5 days
−
| o5/14/08
+
| 06/10/08
 +
| Send marked up PDF to writer
 +
|-
 +
| Approval
 +
| _
 +
| 06/24/08
 +
| Signed approval
 +
 
 +
|}
 +
 
 +
=== COSMOS Installation Guide ===
 +
The COSMOS Installation Guide will be an HTML document that resides on the Eclipse COSMOS development server.
 +
 
 +
{| border="1"
 +
 
  
−
 
 
|-
 
|-
−
| Approval version
+
 
 +
! Activity
 +
! Duration
 +
! Projected Date
 +
! Comments
 +
 
 +
|-
 +
 
 +
| Development outline
 
| n/a
 
| n/a
−
| 06/02/08
+
| '''02/22/08'''
 +
| Provide an outline of your content on the Wiki
 
|-
 
|-
−
| HTML Helps version
+
| Development input
 +
| n/a
 +
| '''04/08/08'''
 +
| Completed information provided to writer
 +
 +
|-
 +
 
 +
| First draft/edit
 +
| _
 +
| 04/18/08
 +
| PDF file provided for markup
 +
|-
 +
| First review
 
| 5 days
 
| 5 days
−
| 06/04/08
+
| 04/24/08
 +
| Send marked up PDF to writer
 +
 +
|-
  
 +
| Second document draft 
 +
 +
| _
 +
| 05/20/08
 +
| PDF file for last review
 +
 
 +
|-
 +
| Final review
 +
| 5 days
 +
| 05/27/08
 +
| Send marked up PDF to writer
 +
|-
 +
| Approval
 +
| _
 +
| 06/13/08
 +
| Signed approval
  
 
|}
 
|}
 +
 +
 +
 +
=== COSMOS API document ===
 +
Owner: TBD
 +
Completion date:
 +
 +
 +
 +
[[Category:COSMOS_Documentation]]

Latest revision as of 05:49, 24 July 2008

COSMOS Wiki > COSMOS Document Plan


Documents

There will be three documents:

  • COSMOS User's Guide
  • COSMOS Developer's Guide
  • COSMOS Installation Guide
  • COSMOS API Document

Availablility

  • Documents available two weeks before GA

Milestones

The development of a document consists the following chronological milestones.

  1. Outline draft of development contents on Wiki
  2. Devlopment content available to writer
  3. First draft
  4. Review
  5. Second and final draft (PDF and online helps)
  6. Review
  7. Approval copy
  8. Create PDFs
  9. Provide online helps

COSMOS Documentation Schedule for GA

COSMOS User's Guide

The COSMOS User's Guide will be available as HTML, PDF and online help.

Activity Duration Projected Date Comments
Development outline n/a 02/22/08 Provide an outline of your content on the Wiki
Development input n/a 04/01/08 Completed information provided to writer
First draft/edit _ 04/16/08 PDF file provided for markup and online help plugin
First review 5 days 04/22/08 Send marked up PDF to writer
Second document draft _ 05/12/08 PDF file for last review
Final review 5 days 05/19/08 Send marked up PDF to writer
Approval _ 06/04/08 Signed approval
HTML Helps version _ 06/09/08 Provide online help files


COSMOS Development Guide

The COSMOS Development Guide will be available as HTML on the development server only. Online helps will not be provided for first release.

Activity Duration Projected Date Comments
Development outline n/a 02/28/08 Provide an outline of your content on the Wiki
Development input n/a 04/22/08 Completed information provided to writer
First draft _ 05/13/08 PDF file provided for markup
First review 5 days 05/17/08 Send marked up PDF to writer
Second document draft _ 06/06/08 PDF file for last review


Final review 5 days 06/10/08 Send marked up PDF to writer
Approval _ 06/24/08 Signed approval

COSMOS Installation Guide

The COSMOS Installation Guide will be an HTML document that resides on the Eclipse COSMOS development server.

Activity Duration Projected Date Comments
Development outline n/a 02/22/08 Provide an outline of your content on the Wiki
Development input n/a 04/08/08 Completed information provided to writer
First draft/edit _ 04/18/08 PDF file provided for markup
First review 5 days 04/24/08 Send marked up PDF to writer
Second document draft _ 05/20/08 PDF file for last review
Final review 5 days 05/27/08 Send marked up PDF to writer
Approval _ 06/13/08 Signed approval


COSMOS API document

Owner: TBD Completion date:

Retrieved from "https://wiki.eclipse.org/index.php?title=COSMOS_Document_Schedule&oldid=111159"

This page was last modified 05:49, 24 July 2008 by Paul Stratton. Based on work by Richard Vasconi.

Back to the top