Descriptions of wizards, views, shortcuts. Cite relevant external reference material
When writing
- Get the name of the page right; it match what is on the screen
- Include a paragraph description of what this thing is for
- Include a screen snapshot
- Don't explain how to use this thing; link to a tasks page
- Wait for the developers to Name something in uDig and then describe it with a Reference page
Good Examples
Comments
General reference topics document non-conceptual or non-procedural stand-alone information. Examples of general reference topics can include descriptions of various workbench resources such as wizards, dialogs, views and perspectives, as well as, a list of keyboard shortcuts, a glossary, or JavaDocs information. Reference materials are helpful resources that will assist the user while using the platform. Additionally, you can use this section to site relevant external reference material. Information in general reference topics is often used to supplement other conceptual, task, and reference topics.
