Difference between revisions of "Help screens styleguide"
From Joomla! Documentation
Coder4life (talk | contribs) (New page: This is a work in progress and should be used as a guideline for creating help screens for Joomla 1.6. This offers consistency throughout the help screens to allow for more organization w...) |
(No difference)
|
Revision as of 15:41, 14 May 2010
This is a work in progress and should be used as a guideline for creating help screens for Joomla 1.6. This offers consistency throughout the help screens to allow for more organization when looking at a topic Feel free to add to this.
Overview[edit]
How is this related to Joomla! Is it a component can be accessed from the front-end and/or back of Joomla!?
How to Access[edit]
The path taken to get to the screen.
- Select "menu item" → "submenu item" → "ect."
Description[edit]
This goes into more detail about what the component does. There should be no specific format to this section because the description should be in direct correlatin with the purpose and functionalitly of the component. There may be many subsections to the description that describe more specific details.
Screenshot[edit]
Overall look of the page.
Toolbar[edit]
Describes the available icons and their associated functions for this screen in the toolbar. Use chuncks here because many will be the same for different screens. Best to provide a picture of the toolbar.
Outline[edit]
Describes the available options for this screen. There may be many links within this screen that group to gether certain options. Break down these sections into separte sub-heads and outline their individual functions.
Quick Tips[edit]
Gives some advice to a person, recommends the best options based on a wide audience of people.
Related Information[edit]
Should connect other pages of the Help Wiki