Docs Style Guide

[edit] Please Note

These docs are now deprecated, we have a new Support area located here

Revision as of 04:24, 24 August 2011 by Admin (Talk | contribs)

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.

Type of Pages

There are three main categories of pages.

  1. Glossary Terms
  2. Setting Definitions
  3. How-To Guides

Each one has a different purpose and specific layout.

Glossary Style

This is a simple definition of the term.

  • Example:

If your definition gets long enough to use a table of contents, it's probably not a definition. Keep it simple.

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:

Image Styles

  • DO NOT use spaces in the file names. Dashes are OK.
  • 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.


How-To Guide

This is an in-depth walkthrough of how to use a specific function or complete a task using PageLines.

  • Example: