CDT User Guide style guidelines

[Tanya-Marise De Sousa <tdesous@xxxxxxxxxx>]

The attached document details the style
conventions used in the CDT User Guide for task topics. 



For information on how to contribute help,
refer to http://www.eclipse.org/cdt/. Click on the Articles link on the
left navigation panel. Under the Help heading, see the article "Help
– Part 1 Contributing a little help".

Tanya-Marise de Sousa

Title: CDT overview

CDT User Guide style guidelines

This document lists the style conventions used in the org.eclipse.cdt.doc.user plugin and focuses on task topics. The CDT User Guide has three topic types: Concept, Task and Reference.

Element	Example
Tasks
Begin task titles with a gerund and use sentence capitalization.	Creating a project
Provide a short description on what the user will accomplish.	You can hide files by type that you do not need to see in the C/C++ Projects view.
Include no more than one task for each topic (.html file) and one step for each numbered list item in a task.
Use a sentence fragment followed by a colon before numbered steps and use sentence capitalization.	To hide files by type:
Steps
Document how to access a feature through the menu. Do not provide multiple ways to do something unless the menu-driven method is not always available. Project properties are an example of this. You can set project properties in the New Project wizard, but after the project is created you can only set properties by right-clicking on an individual project or in preferences (for all projects).	Click File > New > Project.
Menu instructions. Note that the term "menu" is not used. The menu path is bolded.
When you must provide multiple ways to do something use the format in the example.	Do one of the following: To set properties for future Standard Make projects, click Window > Preferences . Expand C/C++, click New Make Projects. In the C/C++ Projects view, right-click a project, and select Properties. Select C/C++ Make Project from the list.
To instruct the user to make a choice, use the format in the example.	Do one of the following: To stop the build when an error is encountered, select Stop on error. To continue the build even if an error is encountered, select Keep going on error.
Terminology
Context menu (shortcut menu), instruct the user to "right-click <something>, and select <something>."	In the C/C++ Projects view, right-click a project, and select Properties.
Bold the name of the item being acted on not the name of interface control.	Clear the Default check box.
For results, state the name of the dialog box or wizard that opens as an introductory phrase at the beginning of a step rather than adding the sentence; "The New Project wizard opens."	Click File > New > Project. In the New Project wizard, click C or C++.
Begin a step, where applicable, by telling the user "To <do this>, <do this>."	To change tab settings, type a value in the Value box.
Do not use the word "button". Use "click <name of button>."	Click Next.
Do not use the word "check box". Select or clear check boxes and bold the name of the check box.	Select or clear the Blank check box.
Do not instruct the user to "click on" something. Use "click", "right-click" or "double-click."	In the C/C++ Projects view, double-click your project.
Do not use the word "radio button". Use "click <name of radio button>."	To change the background color, click Custom.
Do not instruct the user to "click on". Use "click the <name of tab>."	Click the General tab.
Do not use the word "tree". Use "Expand <something>, click <something else>.	Click Window > Preferences. Expand C/C++, click C/C++ Editor.
Use "type" instead of "enter."	In the Name box, type a name.

Additional information

For information on how to contribute help, refer to http://www.eclipse.org/cdt/. Click on the Articles link on the left navigation panel. Under the Help heading, see the article "Help – Part 1 Contributing a little help".