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.
Difference between revisions of "COSMOS Document Schedule"
(→COSMOS Development Guide) |
(→COSMOS Installation Guide) |
||
| Line 27: | Line 27: | ||
=== COSMOS Installation Guide === | === COSMOS Installation Guide === | ||
| − | The COSMOS | + | The COSMOS Installation Guide will be an HTML document that resides on the Eclipse COSMOS development server. |
{| border="1" | {| border="1" | ||
| + | |||
|- | |- | ||
| Line 47: | Line 48: | ||
| Development input | | Development input | ||
| n/a | | n/a | ||
| − | | ''' | + | | '''04/08/08''' |
| Completed information provided to writer | | Completed information provided to writer | ||
| Line 54: | Line 55: | ||
| First draft/edit | | First draft/edit | ||
| _ | | _ | ||
| − | | 04/ | + | | 04/18/08 |
| PDF file provided for markup | | PDF file provided for markup | ||
|- | |- | ||
| First review | | First review | ||
| 5 days | | 5 days | ||
| − | | 04/ | + | | 04/24/08 |
| − | | Send | + | | Send marked up PDF to writer |
|- | |- | ||
| − | | Second document draft | + | | Second document draft |
| − | + | ||
| _ | | _ | ||
| − | | 05/ | + | | 05/20/08 |
| PDF file for last review | | PDF file for last review | ||
| − | + | ||
|- | |- | ||
| Final review | | Final review | ||
| 5 days | | 5 days | ||
| − | | 05/ | + | | 05/27/08 |
| Send marked up PDF to writer | | Send marked up PDF to writer | ||
|- | |- | ||
| Approval | | Approval | ||
| _ | | _ | ||
| − | | 06/ | + | | 06/10/08 |
| Signed approval | | Signed approval | ||
|- | |- | ||
| − | | | + | | HTML Helps version |
| _ | | _ | ||
| 06/09/08 | | 06/09/08 | ||
| Line 89: | Line 90: | ||
|} | |} | ||
| − | |||
=== COSMOS User's Guide === | === COSMOS User's Guide === | ||
Revision as of 09:19, 27 March 2008
COSMOS Wiki > COSMOS Document Plan
Contents
Documents
There will be three documents:
- COSMOS Installation Guide
- COSMOS User's Guide
- COSMOS Developer's Guide
Availablility
- Documents available two weeks before GA
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
- Review
- Second and final draft (PDF and online helps)
- Review
- Approval copy
- Create PDFs
- Provide online helps
COSMOS Documentation Schedule for GA
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/10/08 | Signed approval |
| HTML Helps version | _ | 06/09/08 | Provide online help files
|
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 |
| 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/15/08 | Completed information provided to writer |
| First draft | _ | 05/06/08 | PDF file provided for markup |
| First review | 5 days | 05/13/08 | Send marked up PDF to writer |
| Second document draft | _ | 06/03/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 |