Diff for "DocTeam/StyleGuide/UserGuideTemplate"

Not logged in - Log In / Register

Differences between revisions 5 and 6
Revision 5 as of 2008-05-20 04:19:14
Size: 2732
Editor: 65-100-177-47
Comment: Fixed TOC
Revision 6 as of 2008-06-17 14:21:18
Size: 2742
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 15: Line 15:
'''DRAFT: 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.''' '''DRAFT: 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.'''
Line 17: Line 17:
||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">[[TableOfContents]]|| ||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;"><<TableOfContents>>||
Line 37: Line 37:
attachment:screen-shot.png {{attachment:screen-shot.png}}
Line 44: Line 44:
||<tablestyle="float:right; font-size: 0.8em; width:30%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">attachment:proj-announce.png|| ||<tablestyle="float:right; font-size: 0.8em; width:30%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">{{attachment:proj-announce.png}}||

Use this template when writing a new page of the Launchpad user guide.

Important things to remember:

 * The table of contents should only remain if there is more than one section.
 * Keep the "Draft" message until the page has been reviewed and accepted.
 * Remove these instructions and the "Draft" message before publication.

Want to know more? See the DocTeam page.

DRAFT: this page is a work in progress. Please seek further help or check the wiki index for a complete page on this topic.

Overview

Use the first two paragraphs to summarise all the important points about this article.

Tell the reader if this is the information they need as soon as possible.

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.

{i} 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.

screen-shot.png

{i} 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

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.

DocTeam/StyleGuide/UserGuideTemplate (last edited 2008-06-17 14:21:18 by localhost)