The Training Team
The Training team’s mission is to educate both PMI customers and staff on features, benefits, and effective use of the Institute’s IT resources. Our focus is on topics related to PMI’s software solutions and technology resources, and we strive to help both our internal and external customers to understand how to use all the technology resources available to them.
Use of Figures, Images, Lists, and Tables
The Training team currently uses the following icon for online help links. This icon was provided and approved by Online Strategy and Content (OS&C) in 2012.
Suggested Read: PMI style guide technical communication
Figure and Table Captions
- Center reference captions immediately below the figure or table they describe.
- Figure and table captions are 10-point bold in the same font as body text.
- The words “Figure” and “Table” are spelled out and capitalized.
- Figures and tables are represented in a table of contents as Level 4 headings.
- Include figure references in the table of contents as level 4 headings. Technical Communication and Training team templates no longer use a separate table of figures.
Images and Flowcharts
The proper use of images helps technical documents provide a visual learning experience to readers. Images and flowcharts help illustrate complex processes and concepts. Adhere to the following guidelines when using images in text:
- In Word documents, keep images in line with text.
- Do not repeat images unless it is necessary to describe a process or sequence of steps.
- In figure and table captions, text should not wrap around figures. If you are using a graphic in a sentence, text wrapping is permitted. Wrap text around figures only for explanatory pointers to the figure.
- Insert Visio drawings as .gif or .jpg images.
This section describes style guidelines for lists used in text. These guidelines apply to Word documents and online help applications.
- Numbered list—use to imply a series of steps that must be completed in a set order. Use san-serif Arabic numerals with a period, not a close parenthesis, after the number.
- Bullet list—use to imply that all points in a list are equally important to the reader. Use the filled-in bullet
- Do not break down lists into lowercase letters or Roman numerals.
- If you need to create a sublist under a numbered or bullet list, use the hollow bullet.
Also Read: PMIs global standards titles
This section describes style guidelines for tables in the text. These guidelines apply to Word documents and online help applications.
- The table uses the Body Text font and style for all cell contents.
- Column headings use an Arial white bold style set against a 25% grey background shading.
- The table is set to show grids.
- Do not use underlines for column or row headings.
- Tables should be left-justified and vertically centered. The text within the table should also be left justified. Column headings are left-justified, bold. Row headings, if they exist, are also left-justified.
- Set the table so that column headings will repeat if the table breaks across pages. First, highlight the entire table. Next, go to the Table dropdown and select Heading Rows Repeat.
- Set the table so that no individual rows break across pages. First, highlight the entire table. Next, right-click the highlighted table > Table Properties dialog window > Rows tab > under Options > deselect Allow row to break across pages.
|Column 1||Column 2|
Screen Control and Navigation Description
Common Screen Controls
- Dialog box –A window that allows or requires input from the user.
- Message box –A window that does not allow or require input from the user.
- Page or screen –What displays on your PC when navigating through a website or web-based application. Both “page” and “screen” are acceptable. However, they must be used consistently and not be interchanged within one document.
- Radio button—A clickable field that lets you select between two or more choices.
Path in Text
Use carats (Insert > References > Caption) to show file and folder navigation paths, or
breadcrumbs, in text. Most training materials and user guides show progression with animation or through images.
Computer Code Examples in Text
Use Courier New 10 to show computer code examples in text. Set the code in a text box with a broken border as shown below. Retain all indents and spacing, comments, and syntax as you received them from the developer.
- Tells them what I like to do.
PMI Style Guide_10-26-16
<param name=”maximumValue”>Maximum number of times to tell them</param> public void DoThis(int maximumValue)
for (int i = 0; i < maximumValue; i++) Console.WriteLine(“I’m into nuggets “);
Also Read: PMI content types