This repository was archived by the owner on Nov 8, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 179
Page Structure
Jonathan Garbee edited this page Aug 19, 2014
·
6 revisions
The documentation should have consistent flow. This goes for having certain naming conventions for headings to the use of images and other helpers. Here is a proposed structure that pages should follow. This is NOT yet official. No discussion has been had to this end it is just Garbee's ramblings.
We have certain use-cases for sections that happen to fit in many areas. These are:
- Advantages - This discusses the specific reasons that the feature offered is superior to more traditional/widely accepted methods.
- Limitations - This discusses known drawbacks to the tools. This section should always include some input at the end about why despite the limitations the tool is still powerful. A good example of this is the Limitations of device mode.
- Tricks - A section dedicated to nice additional uses of the tools that don't fit well into a quick "protip" note within the documentation flow.
While not all pages will need these sections, they are the Headings to be used when they are needed.