Docs Style Guide
| Line 20: | Line 20: | ||
# How-To Guides | # How-To Guides | ||
| − | |||
=== Glossary Style === | === Glossary Style === | ||
| Line 36: | Line 35: | ||
How-tos will consist of a text walk-through with supporting images. | How-tos will consist of a text walk-through with supporting images. | ||
| − | |||
The walkthrough should also be available as a video in as many cases as possible. | The walkthrough should also be available as a video in as many cases as possible. | ||
| − | + | '''Referencing Tools''' | |
| + | |||
| + | When referencing the use of tools like FTP clients or CSS editors. Reference the section on the <nowiki>[[Tools]]</nowiki> page rather than the tool itself. All suggested tools should be included and described on the Tools page. | ||
| + | |||
| + | |||
| + | '''Image Styles''' | ||
* DO NOT use spaces in the file names. Dashes are OK. | * DO NOT use spaces in the file names. Dashes are OK. | ||
| Line 49: | Line 52: | ||
* If you upload an image by mistake, ask an admin to remove it. | * If you upload an image by mistake, ask an admin to remove it. | ||
| − | + | '''Video Styles''' | |
* Use a friendly conversational tone in your voice | * Use a friendly conversational tone in your voice | ||
Revision as of 18:57, 1 September 2011
Lets talk about style!
PageLines, like yourself, has it's own style. This page will discuss how to keep this style consistent in all the pages in the Docs.
Contents |
General Style
Conversational. Write like you would talk. No one wants to read another dry software manual. Keep it technical but be upbeat and fun when appropriate.
Avoid using 10 words when 3 will do. Keep it concise and it will communicate better.
PageLines belongs to the community, tell it that way. Use PageLines instead of 'I, we, our" its not them vs us its all of us!
When using PageLines on WordPress to do screenshots and videos for the Docs, please use a clean, localhost install of PageLines on WordPress. All settings should be reset to default in-between writing new How-Tos.
Type of Pages
There are two main categories of articles.
- Glossary Terms
- How-To Guides
Glossary Style
This is a simple definition of the term.
- Example:
All Glossary items will be organized in alphbetical order on the Glossary page.
If your definition gets long enough to use a table of contents, it's probably not a definition. Keep it clear and concise.
How-To Guide
This is an in-depth walkthrough of how to use a specific function or complete a task using PageLines.
How-tos will consist of a text walk-through with supporting images.
The walkthrough should also be available as a video in as many cases as possible.
Referencing Tools
When referencing the use of tools like FTP clients or CSS editors. Reference the section on the [[Tools]] page rather than the tool itself. All suggested tools should be included and described on the Tools page.
Image Styles
- DO NOT use spaces in the file names. Dashes are OK.
- Crop out all browser items in your images
- Images should be no wider than 725 pixels.
- If possible keep your image size below 60k.
- Please use jpg or png formats.
- If you upload an image by mistake, ask an admin to remove it.
Video Styles
- Use a friendly conversational tone in your voice
- Be happy and have a good attitude, smile when you are recording and it will come through the audio
- Text pop-ups should be a transparent black box on the bottom of the video, using the Georgia font
- Transitions should be fades
- No gradients, no added colors
- Example: