Platform ISV Doc Plan

Last updated:  19 June 2002

Content

Priority 1 items

Component Content Status
Team New chapter

Initial draft complete.  Appears in F3 build.  

Need to incorporate KM review comments.
Product config & install New chapter Initial draft complete.  Appears in 20020604 build.  Need to incorporate ref material.  

Need to incorporate Jeem review comments and reference material.
Need to incorporate NLS/fragment dir info (awaiting info from DJ)
Debug/Launch New chapter Initial draft complete.  Appears in 20020604 build.  

Need to incorporate DW review comments
Help Rewrite old chapter to discuss new TOC structure.  Add sections on info pops and active help. Initial draft complete.  Appears in 20020604 build.  

Need to incorporate KH ref material.  Need to incorporate Konrad comments.
Core Updated features:  project natures (one-of-nature, other changes), project description changes, file modification validator, move/delete hook, derived resources, team private resources Appears in I20020618. 

Awaiting DJ comments.
Workbench, Dialogs, Preferences/Properties Updated features, readme example has been reworked and all chapters need updating. In progress.
SWT Minor revisions, add discussion of FormLayout Appears in I20020620
ALL CHAPTERS All chapters should be reviewed by component owners after first pass of edits. In progress.
ALL CHAPTERS Screen snaps Appears in I20020620
REF DOC Check javadoc TOC against build scripts.  Check extension point TOC against plug-in doc content. Done.  Notified owners with sketchy extension point doc.

Priority 2 items

Component Content Status
Search/compare framework New chapter.  Minimum requirement:  roadmap. Not started.
Ant chapter New chapter.  Minimum requirement:  roadmap. Appears in I20020620

Schedule

May 13-19 Planning.  Finish overall TOC for updated Developer Guide. 
May 20-26 Finish individual outlines for new chapters and establish reviewer.
May 27-31 Start writing new chapters (VCM, Product configuration, Debug, Help)
June 3-9 Finish new chapters and send for review.
June 10-16 Update Core, SWT, Workbench chapters and send for review.  Review any chapters that were not touched and get component owner review.
June 17-21 Incorporate review feedback, take screen snaps, fix up reference doc pointers and structure.  Search/compare framework chapter/roadmap (time permitting)
June 24 Doc frozen.