Documentation requirements

Glossary Item Box

Introduction: function of the application.
Technical requirements.
Application installation specifics (list any settings required in addition to the standard installation procedure).
Description of the setup steps needed to get started the application.
Description of the setup steps for the correct operation of the application (e.g., configuring additional features, description of processes and procedures that handle data without users’ participation, etc.).

Format: PDF.
The file must include a title page and a table of contents in addition to its target content.
The title page must include the application name and company name/logo.
The contents must support automatic updates.
Documentation titles must be as follows: “%Application name% installation and setup guide” and “%Application name% user guide”.
Use this link to download the file template.

The text must be logically structured. Permitted format elements include headings, subheadings, marked/numbered lists and the bold font.
Use imperative verbs for step-by-step instructions.
The instructions must be sufficiently detailed and include all steps necessary to reproduce the described procedure. Any elements of the functionality, such as object names, UI elements and software components referenced in the documentation must match those in the actual application.
The terminology must match that of the Creatio documentation. The terminology must be consistent throughout the documentation. Examples of terms:
- Section;
- List;
- Page, record page;
- Detail;
- Tab;
- Field;
- Group of fields;
- Action area;
- System Designer;
- Communication panel.
Use the “em dash” (Alt+0151) “—” in the texts. Use the “en dash” (Alt+0150) between numbers: “10–15”.
Do not use blank spaces in the “etc.”, “e.g.” contractions.
Spell the names of the keyboard keys, e.g., arrows, functional keys, case shift keys with capital letters Example: “Press ALT+F3”. Do not spell with capital letters any descriptive keys, e.g., “Windows”.
Enclose captions of interface elements in square brackets. Example: “Click [New]”, “Populate the [Name] field”.
Use quotation marks: “”.

Use the “Verdana” font throughout the text, grey color (RGB 89, 89, 89).
The font size of the body text (including tables): 10 px.
The font size of the subheadings: 14 px.
The font size of the headings: 16 px.
The font size of the picture captions: 9 px.
Line spacing of the body text: 1.15.
Line spacing of the headings (including picture and table captions): 1.5.
Page margins: 2.5.
Do not use forced hyphenation in the text.
Do not use indent spaces on normal text paragraphs.
First level indent space: 0.63. Second level indent space: 1.9.
Remove any blank paragraphs.
Continuous numbering used in pictures and tables.
Use the “Full justify” alignment for the body text.
Use the “Left” alignment for headings and subheadings.
Blue color (RGB 100, 184, 223) used for the marked and numbered lists of the first level.

Permitted image formats in the documentation: PNG or JPEG.
The key interface elements (fields, details, areas) can be highlighted. Use marquee select (frame width – 2 px) to highlight elements on a screenshot. Maximum number of highlighted elements in a screenshot – 2. Do not use other hightlighting means (arrows, text, etc.) in screenshots.
All screenshots have captions and numbers.
The picture caption and number placed at the top of the picture. Font. Verdana, font size – 8, color – light-grey (RGB 150, 150, 150). Left alignment. Line spacing of picture captions: 1.5.
Text must reference all the pictures.
Picture layout: “In Line with Text”.
Alignment: “Full justify”.

Documentation