3.1 Documentation Plan for Platform Search, Platform Text, JDT Text and JDT UI

Last revised 13:32 CET June 22, 2005

This plan is under continuous refinement. Please send comments about this draft plan to the platform-text@eclipse.org developer mailing list.

  • User Documentation

    • go through all our documentation and remove all out-dated contents
    • check all views and editors in the new dynamic Help view:
      • summary is correct
      • links work and make sense
    • Getting Started section: [David]
      • update to 3.1
      • add section about J2SE 5.0
      • adapt project setup tutorial to new project wizard [Philippe]
      • make sure the Getting Started section is of high-quality and easy to read
      • test the getting started: go through it step by step
    • update the Tips & Tricks document
    • complete the What's New in 3.1 section [Dirk and Tom]
    • update the Welcome page, ensure there's a link to the icon's list
    • update the Readme document [Dirk and Dani]
    • update the list of used icons
    • check all our examples and corresponding example descriptions

  • ISV Documentation [Dirk, Tom]

    • review and complete extension point descriptions in the schemas (verify that all appear)
    • verify that all APIs and extension-points appear in the corresponding programmer's guide [Dani]

  • Code

    • Javadoc [Dani]
      • verify that all APIs have Javadoc
      • check spelling
      • new APIs have the @since3.1 tag
    • spell check all *.properties files [Dani]
    • spell check all *.htm* files
    • provide component.xml for text plug-ins [Dani]
  • Miscellaneous
    • ensure there are no mixed line delimiters
    • redo all screen shots
    • check the whole doc with a link checker tool [Dani]
    • remove the copyright link and the copyright gif (tool see bug 99017) [Dani]
Legend
item is under development. item is under investigation.
item is finished. ( ) item is time permitted.
[xyz] item is deferred to or continues in xyz. new