Bug Description Specification

I. Purpose and scope of application 1.1 purpose

The purpose of reporting a software test error is to ensure that the person who fixes the error can clearly report the error, thereby facilitating the analysis of the cause of the error, locating the error, and then correcting it. Therefore, the basic requirements of reporting software testing errors are accurate, concise, complete, and normative.

1.2 Scope of application

This specification applies to the specification and restriction of the bug description during the test.

Second, the description of the bug specification

1. Description: Concise, accurate, complete, revealing the essence of the error, record the location of defects or errors to accurately reflect the essence of the error, short and clear. To facilitate the search for a specified test error, the description contains the user interface (UI) when the error occurred. For example, record the name of a dialog box's caption, menu, button, and other controls.

2. Clearly indicate the type of error: layout, translation, function, etc.;

According to the error phenomenon, summarize the type of judgment error. For example, layout errors, translation errors, functional errors, double-byte errors, which are the most common types of defects or errors, and other forms of defects or errors that fall into one of these forms.

3. Use automatic numeric serial numbers between short lines, use the same font, font size, line spacing, use the same font, size, line spacing between short lines, and ensure that the records are formatted consistently and professionally.

4. The UI should be quoted, can be single quotation marks, it is recommended to use double quotation marks;

The UI is quoted to make it easy to distinguish between UI and plain text, making it easier to identify, locate flaws or errors.

5. Each step as far as possible to record only one operation, ensure concise, organized orderly, easy to repeat the operation of steps.

6. Confirm that the procedure is complete, accurate and brief;

Ensure fast and accurate repetition of errors, "integrity" is not missing, "accurate" is the correct step, "short" that there is no unnecessary steps.

7. Select the mode of image capture according to the type of defect or error;

In order to visually observe defects or errors, it is often necessary to attach defects or errors to the interface, as an attachment in the form of a bitmap attached to the "attachment" section of the record. To save space and to truly reflect defects or false nature, you can capture the full screen, the active window, and the local area when defects or errors occur.

8. Attach the necessary special documents, personal suggestions and annotations;

If you open a particular document and create a flaw or error, you must attach the document so that you can reproduce the defect or error quickly. Sometimes, in order for a defect or error modifier to further clarify the defect or the wrong performance, you can attach a personal modification suggestion or note.

9. Check spelling and grammatical errors;

Before submitting each defect or error, check the spelling and grammar to make sure that the content is correct and that the error is correctly described.

10. Use industry-customary expressions and expressions as far as possible;

Use the industry's customary expression and expression methods to ensure accurate expression and professionalism.

11. Common UI should be unified and accurate;

The UI of the error report is consistent with the tested software UI for easy locating.

12. Use phrases and phrases as much as possible to avoid complex sentence patterns;

The purpose of the software error management database is to make it easy to locate errors, therefore, it is necessary to objectively describe the operation steps without the need for cosmetic words and complex sentence patterns to enhance readability.

13. Each error report includes only one error;

Each error report includes only one error, allowing the error modifier to quickly locate an error and focus on correcting only one error at a time. The verifier checks only one error at a time to see if it has been corrected correctly.

Bug Description Specification