Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Eclipse Doc Checklist"
Line 8: | Line 8: | ||
== User Documentation == | == User Documentation == | ||
− | * | + | * For all existing user documentation: |
− | * Add Concepts and Tasks entries for | + | ** Remove/correct out-dated contents |
+ | ** Ensure that the contents of the topic are appropriate for the category the topic is in | ||
+ | * For significant new features in the current release: | ||
+ | ** Add Concepts and Tasks entries | ||
+ | ** Search the existing help topics for other pages that relate to the topic you are writing about and add them as "Related <topic>" links | ||
* Check all views and editors in the new dynamic Help view | * Check all views and editors in the new dynamic Help view | ||
** Ensure summary is correct | ** Ensure summary is correct | ||
Line 25: | Line 29: | ||
== ISV Documentation == | == ISV Documentation == | ||
+ | * For significant new API in the current release: | ||
+ | ** Add Programmer's Guide entries | ||
+ | ** Link new topics to related concepts and tasks in the user guide | ||
+ | ** Link old topics to new topics where appropriate | ||
+ | ** Search the existing help topics for other pages that relate to the topic you are writing about and consider adding them as "Related <topic>" links | ||
* Review and complete extension point descriptions in the schemas | * Review and complete extension point descriptions in the schemas | ||
− | * Verify that all APIs and extension-points appear in the | + | * Verify that all APIs and extension-points appear in the Reference section (see [[How to add things to the Eclipse doc]]) |
* Verify that extension points added in 3.2 are marked "Since 3.2" | * Verify that extension points added in 3.2 are marked "Since 3.2" | ||
* Update migration guide | * Update migration guide | ||
Line 35: | Line 44: | ||
** Verify that all APIs have Javadoc | ** Verify that all APIs have Javadoc | ||
** Check spelling (use American English) | ** Check spelling (use American English) | ||
− | ** Ensure new APIs have the @ | + | ** Ensure new APIs have the @since 3.2 tag |
* spell check all *.properties files (use American English) | * spell check all *.properties files (use American English) | ||
* Verify that component.xml files are correct | * Verify that component.xml files are correct |
Revision as of 14:07, 16 May 2006
This checklist can be used to ensure that all documentation work for a component gets completed. You may find it useful to make a copy of this page for your component, adding extra items that are specific for you, and checking items off as they are completed.
General Notes
- Make sure you use an HTML editor that will not munge the documentation source. Good examples are the Eclipse text editor, or the HTML editor in WTP (Help > Software Updates > Find new features to Install > Callisto Discovery Site > Select the "Web Standard Tools" feature and click "Select Required").
- Make sure new additions and changes adhere to the Eclipse Doc Style Guide
User Documentation
- For all existing user documentation:
- Remove/correct out-dated contents
- Ensure that the contents of the topic are appropriate for the category the topic is in
- For significant new features in the current release:
- Add Concepts and Tasks entries
- Search the existing help topics for other pages that relate to the topic you are writing about and add them as "Related <topic>" links
- Check all views and editors in the new dynamic Help view
- Ensure summary is correct
- Ensure links work and make sense
- Check all dialogs and wizards to ensure that the (?) button or F1 shows relevant information
- Getting Started section:
- Make sure the Platform Getting Started section is of high-quality and easy to read
- Test the Platform getting started: go through it step by step
- Update the Tips & Tricks document
- Complete the What's New in 3.2 section
- Update the list of used icons
- Check all examples and corresponding example descriptions
- Ensure command line arguments under Tasks > Running Eclipse are updated and correct
ISV Documentation
- For significant new API in the current release:
- Add Programmer's Guide entries
- Link new topics to related concepts and tasks in the user guide
- Link old topics to new topics where appropriate
- Search the existing help topics for other pages that relate to the topic you are writing about and consider adding them as "Related <topic>" links
- Review and complete extension point descriptions in the schemas
- Verify that all APIs and extension-points appear in the Reference section (see How to add things to the Eclipse doc)
- Verify that extension points added in 3.2 are marked "Since 3.2"
- Update migration guide
Code
- Javadoc
- Verify that all APIs have Javadoc
- Check spelling (use American English)
- Ensure new APIs have the @since 3.2 tag
- spell check all *.properties files (use American English)
- Verify that component.xml files are correct
Miscellaneous
- Update the eclipse_readme.html document
- Ensure there are no mixed line delimiters
- Redo screen shots if necessary
- Check the whole doc with a link checker tool
Back to Eclipse Documentation.