3.2 Documentation Plan

Last revised 16:55 CET May 22, 2006

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

Important Notes:

  • all HTML editing must take place in the text editor or the HTML editor defined by Martin (TBD, see below)
  • all screenshots have to be made on Johannes' machine
  • make sure new additions and changes adhere to the Eclipse Doc Style Guide

  • User Documentation

    • go through all our documentation and remove all out-dated contents [Tobias, Tom]
      will discuss this in the arch call what we do with concepts and tasks section
      ⇒all doc we ship must be up-to-date i.e. either update out-dated content or remove it
    • check all views and editors in the new dynamic Help view: [Markus]
      • summary is correct
      • links work and make sense
    • check all our dialogs and wizards that the (?) button show relvant information [Markus]
    • Getting Started section:
      • make sure the Platform Getting Started section is of high-quality and easy to read [Tom]
      • make sure the JDT Getting Started section is of high-quality and easy to read [Martin]
      • test the Platform getting started: go through it step by step [Tom]
      • test the JDT getting started: go through it step by step [Martin]
      • add section about Quick views (Ctrl+O and Ctrl+T) to "Editing Java Elements" [Johannes]
      • spacing between list elements [Tom]
        ⇒Tom filed bug 141960 fixed > 20060516.
      • inital project setup with JUnit (3.8.1) source [Martin]
      • add JUnit4 doc to the JUnit section [TBD]
    • update the Tips & Tricks document [Benno with input from Martin and Dani]
    • complete the What's New in 3.2 section [Benno with input from Martin and Dani]
    • update the Readme document [JDT UI: Martin, Platform and JDT Text: Dani]
    • update the list of used icons [Martin]
    • check why source link does not work in Java Editor example [Dani]
      ⇒see bug 120748
    • check all our examples and corresponding example descriptions [Johannes]

  • ISV Documentation

    • review and complete extension point descriptions in the schemas (verify that all appear) [Tom]
    • verify that all APIs and extension-points appear in the corresponding programmer's guide [Tom]
    • verify that extension points added in 3.2 are marked "Since 3.2" [Tom]
    • update migration guide [Dani, Martin]

  • Code

    • Javadoc [Tobias for JDT UI, Tom for Platform Text and JDT Text]
      • verify that all APIs have Javadoc
      • check spelling (use American English)
      • new APIs have the @since3.2 tag
    • spell check all *.properties files (use American English) [Tobias]
      ask Dani, he has a tool that helps with this task.
    • verify that component.xml files are correct [Martin, Tom]
  • Miscellaneous
    • define HTML editor along with settings to be used [Martin]
    • ensure there are no mixed line delimiters [Dani]
    • redo all screen shots [Johannes]
    • check the whole doc with a link checker tool [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