launchpad helpDRAFT: this page is a work in progress. Please [:Feedback:seek further help] or check the [:TitleIndex:wiki index] for a complete page on this topic.
ContentsBRTableOfContents |
Overview
Instructional text
Where appropriate, use step by step instructions:
Step 1: Give concise and unambiguous instructions.
Step 2: Try not to state the obvious, unless you're writing for a novice user.
Note: Highlight important information with a note.
Step 3: Use a well cropped screen shot if it will help orient the reader. Don't let the screen shot replace instructional text: not everyone can see your screen shot. Don't worry about borders or annotation for small, cropped screen shots such as this.
attachment:screen-shot.png
Warning: If you're about to tell the reader to delete or otherwise change something that would be hard to restore, warn them.
Full screen shots
attachment:proj-announce.png |
Describe the screen shot here |
Some screen shots will be better placed to the right of your text. As they're not placed directly below the text that they support, use a border and short description.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam sagittis. Aliquam eros dui, scelerisque id, consequat in, accumsan vitae, pede. Suspendisse neque ligula, scelerisque ac, mattis ut, aliquam quis, odio.
Proin nunc nisi, fringilla ac, congue ac, luctus eu, lacus. Maecenas ac purus. Cras felis metus, ultricies non, euismod ac, accumsan eleifend, leo. Quisque imperdiet tempus tellus.
Ut euismod, diam nec adipiscing interdum, tortor orci fringilla nisi, vel blandit erat magna at nisi. Fusce hendrerit odio non metus. Mauris nisl massa, dapibus id, feugiat quis, blandit a, quam. Integer tincidunt feugiat nunc. Curabitur iaculis egestas elit. Nam imperdiet suscipit odio.
