...
Additional tips and helpful information
Screenshots
Make a comment for any screenshots that need to be included or replaced laterNOTE: Many of the screenshots in DocBook have already been updated. These updates are not reflected in the linked spreadsheet documents but do not worry about capturing the standard shots (noted below).
As needed:
- Create output in .png format.
- To improve legibility of text on the image, capture the largest image possible given the size of the computer screen you are using. Oversized screen images can be resized as needed in Oxygen.
- For each screen capture of an e-doc, only capture the e-doc.
- For your reference, this is the standard in which screenshots should be included in our documentation:
- For e-docs:
- Under 'Document Layout', insert a single full-length screen shot showing the entire e-doc as it displays when the user first accesses it from the menu. For most e-docs, this means the screen will be shown in create mode rather than edit mode. If the initial display is a search screen, use separate screen shots to show the initial search screen, the results of a search, and the screen display after selecting one of the e-docs listed in the results.
- Under the subheading for each tab, insert a screen shot of the tab.
- Under 'Process Overview', if you are documenting e-doc-specific processes and if screen shots will aid in user comprehension, include shots of parts of the screen that change.
- For maintenance e-docs:
- Include only a full-length screen shot screenshot of the e-doc in edit mode. Do not include separate images of individual tabs.
- For admin e-docs:
- Include only a full-length screen shot screenshot of the initial display of the e-doc.
- For interfaces:
- Include an initial view screen shot.
- Include screenshots to note steps in the process as necessary.
- For e-docs:
Infrastructure Basics
(will be updated for 1.0)
...