Docs Style Guide
(Difference between revisions)
(Created page with "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. == General Style == ...") |
|||
| Line 27: | Line 27: | ||
=== How-To Guide === | === How-To Guide === | ||
| − | This is an in-depth walkthrough of how to use a specific function | + | This is an in-depth walkthrough of how to use a specific function or complete a task using PageLines. |
*Example: | *Example: | ||
Revision as of 04:08, 24 August 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 don't be afraid to add your own flare to keep the readers attention.
There are three main categories of pages.
- Glossary Terms
- Setting Definitions
- How-To Guides
Each one has a different purpose and specific layout.
Glossary Style
This is a simple definition of the term.
- Example:
Setting Definitions
This is an explanation of what the setting does. Along with a before and after picture of how the setting effects a website.
- Example:
How-To Guide
This is an in-depth walkthrough of how to use a specific function or complete a task using PageLines.
- Example: