1. 1. Home Page

(1). Product name: "Product name"+line break+"User Manual" starts with bold characters and is located in the vertical and horizontal center of the page;

(2). Version number: "Version number: V+ Version serial number", located below the product name, bold in bold, horizontally centered and vertically centered;

(3). Company name: the company written in bold is "* * * * * * * *", which is located in the horizontal center at the bottom of the page;

1.2. Contents

(1). The directory font is bold No.2, horizontally centered and located at the top of the page;

(2) List of contents: the font is Song Ti No.5, and the first to third level titles are displayed;

1.3. Title and number

1.3. 1. 1

(1). The serial number is "1, 2,3,";

(2) Style name: title1;

(3). Font format: Times New Roman II, bold, 5 points before and after the paragraph, single-line spacing;

(4) The outline level is1;

1.3.2. Subtitle

(1). The serial number is "1. 1, 1.2,1.3,2.1,2.2,2.3";

(2) Stylistic name: Title 2;

(3) Font format: Times New Roman number, bold, 5 points before and after the paragraph, and single-line spacing;

(4). Outline Level II;

1.3.3. Three-level title

(1). The serial numbers are "1. 1.1.2,1.3,1.2."

(2) Stylistic name: Title 3;

(3). Font format: Times New Roman in Chinese, small four, bold, 5 points before and after the paragraph, single-line spacing;

(4). Outline level 3;

1.3.4. Four-level title

(1). The serial numbers are "1. 1, 1. 1. 1 .2,1.

(2) Stylistic name: Title 4;

(3) Font format: Times New Roman number, bold, 5 points before and after the paragraph, and single-line spacing;

(4). Outline level 4;

1.3.5. Digital setting

(1). Primary numbering: (1), (2) and (3)- "numbering 1" style, with two characters indented before the text;

(2) Secondary numbering: A, B, C,-"No.2" style, with three characters indented before the text;

(3). Three-level numbering: I, ii, iii,-"No.3" style, with 4 characters indented before the text;

1.4. Text

(1). Text: Song Ti No.5, 1.5 times the line spacing, and the paragraph head is indented by 2 words;

(2). Window name, path name, label name, [] common menu items or tree-structured menu items, buttons in the window, → continuous selection menu or submenu or tree-structured path mark;

(3). Prompt mark: Note:, Example:, Prompt:, Operation premise:, Single line, No.5 is bold and not indented;

(4) Screenshot: If the border is not complete, you need to add a border with a color similar to that of the cut picture to keep the integrity of the screenshot. Some contents that are difficult to describe in words can be marked in red font Song Ti No.5 on the screenshot. On the premise of ensuring the integrity of interface elements, you can take screenshots by narrowing the browser interface, which can make the cut pictures clearer. At the same time, pay attention to the use of screenshot tools and control the size of screenshot files.

(5) Legend: It contains the chapter number, and the style is as shown in Figure 5- 1, which is located at the bottom of the picture and horizontally centered. The legend is quoted as "as shown in Figure 5- 1".

1.5. Header and footer

Header: No.5 in the middle/lower left, with horizontal line thickness of 1.5 point. There is no header on the first page, but it is set from the table of contents on the second page.

Footer: set page number: No.5 central page does not set page number, starting from the table of contents on page 2, and the initial value is 1.

Writing requirements

2. 1. Writing content

(1). Complete

A good user manual should at least include all relevant contents of software products and guide users to install, set up and use the software smoothly. Ensuring the comprehensiveness and completeness of the content is an important aspect to grasp the quality of the user manual.

(2) Consistency

The content of the user manual should not only ensure its comprehensiveness and completeness, but also ensure the consistency with the actual function of the software version released together.

(3) accuracy

After the user manual is written, it is best to arrange personnel to review it, to ensure that the rules of completeness, language, spelling and grammar, coherence and format are observed, and to find and correct mistakes in the manual in time, such as typos, picture serial numbers inconsistent with descriptions, etc.

(4) Consistency

The description language and style of the whole user manual are as uniform as possible, which is convenient for users to read.

2.2. Writing style

(1). The description specification is accurate, and the contents, methods and viewpoints should be accurate and appropriate. Words should be standardized, unified and standardized.

(2) Assuming that the user knows nothing, each step in the operation process should be described in detail.

(3) Make the information into tables as much as possible. Tables can improve the readability of information. When you need to describe objects according to different foundations or compare objects between different dimensions, you can use tables.

(4). Easy to understand, try not to use more esoteric computer terms, and if it is inevitable, give appropriate explanations and explanations.

(5) The hierarchy is clear, and the content of each section must be clear, so that users can easily find what they need through the catalogue; Pay attention to the division of paragraphs, each paragraph should not be too long, and highlight the key points, otherwise users will not easily get the essence.

(6) consistency. The concepts and terms used in the user manual should be consistent.

(7). Analyze possible failures and tell users how to deal with problems. If you have an independent problem solving manual, guide users to find more information there.

(8) Illustrate with pictures and appropriate examples. Examples help users to quickly grasp concepts and better understand their contents.