Documentation Standard
Section 3.1 - Model Text

From 3.1.11 Figures.

3.1.11.1 Location of figures.

Each figure shall be placed following, or within, the paragraph containing a reference to it. If figures are numerous and their location, as indicated above, would interfere with the correct sequencing of paragraphs and cause difficulty in understanding or interpretation, they may be placed in numerical sequence at the end of the document before any appendix or index.

3.1.11.2 Preparation of figures.

All figures shall be titled, and they shall be numbered consecutively with Arabic numerals in the order in which they are referenced in the document, even if only one figure is referenced in the document. Figures added after the highest numbered figure are assigned the next higher Arabic numeral. The word "FIGURE" shall be in full and capitalized; followed by the Arabic numeral and a full stop (period); followed by the underlined, italicized, or bold-face title. Only the first letter of the title shall be capitalized. Figure titles shall be centred below the graphic and, if possible, shall be on the same line with the figure number. If the title of the figure is too long to be typed on one line, the second line shall be aligned with the first letter of the title. The contents of a figure shall be arranged to illustrate the relationship of the information being described. When a figure is of such width as to make it impracticable to place it in the normal position on the page, it shall be rotated anti-clockwise by 90 degrees.

3.1.11.3 Continuation of figures.

Large figures may be broken and, if possible, printed on facing pages. When a figure is continued on the next page, the number and title shall be repeated below the figure with a dash (hyphen) followed by the word "Continued" at the end of the title; for example, "FIGURE 1. Example of the digital system - Continued.".

3.1.11.4 Types of figures.

Types of figures are photographs, line drawings, graphs, charts, and diagrams.

• 3.1.11.4.1 Photographs.
• Photographs should be avoided, however, there use shall be restricted to screen displays when absolutely necessary.
• 3.1.11.4.2 Line drawings.
• Line drawings show the detail of objects as in sketches, etc., they are rarely necessary in these types of documents.

• 3.1.11.4.3 Diagrams
  • Diagrams are regularly required in documentation.
    Consideration shall be given to using diagrams for:
    1. illustrating processes to show the order in which activities occur, including areas where choices can be made;
    2. describing complicated concepts and showing how features relate to each other.
  • Consideration shall be given to ensure that the readers of the documentation understand the conventions and will understand the diagrams, e.g., only use certain types of flow charts if the users are expected to understand them.
    
  • 3.1.11.4.4 Graphs and charts.
  • Graphs and charts may be used to explain more clearly the information than when in words and numbers. Graphs and charts are used in reports to convey differences and trends rather than specific quantities.

3.1.11.4 Types of figures.

For diagrams (and outline drawings when appropriate), the following conventions shall be observed for consistency:

• Line width;
• Fonts;
• Sizes of arrow heads;
• Shading;
• Security markings;

Back to Home page MANAGING STANDARDS Home page

Please send any beneficial comments or identification of errors using the following form to: kenr@wysywig.airtime.co.uk