How To Write Documentation

Table of contents:

How To Write Documentation
How To Write Documentation

Video: How To Write Documentation

Video: How To Write Documentation
Video: Writing effective documentation | Beth Aitman | #LeadDevBerlin 2024, December
Anonim

Registration of a new enterprise involves not only entering data about it into the Unified State Register of Legal Entities and opening a bank account, it is also necessary to draw up a number of internal documents that will determine the procedure for the operation of the enterprise. If you are starting to draw up documentation, adhere to certain rules. We will consider the drafting of internal legal acts using the example of a provision, since similar requirements are imposed on other documents (rules, instructions).

How to write documentation
How to write documentation

Instructions

Step 1

Determine the type of document and its type. So, the provisions can be about organizations; collegial and advisory bodies (board of directors, management board); about structural divisions or services; on the status of provisional bodies (commissions, councils). The position can be specific (individual) and typical (approximate).

Step 2

Draw up the document on the general letterhead of the company. Specify the following details: the name of the company, the type of document, the date (the date of its approval is considered the date of the position), the number of the document. Indicate where it was compiled and the title. Remember that the title must be consistent with the name of the document type - for example, "Regulations (about what?) On accounting".

Step 3

Design the main text of the regulation. Provisions, as a rule, have a complex text structure, they involve chapters, paragraphs and subparagraphs. When drawing up a document, number chapters in Roman numerals, and paragraphs and subparagraphs in Arabic.

Step 4

By structure, the text is divided into semantic sections. In the General Provisions section, provide the basic information. So, if you are drawing up a regulation on a structural unit, indicate on the basis of which document the unit was created, what legal (or other) norms it is guided by in its work, whether it has its own seal.

Step 5

In the section "Aims and Objectives", state the direction of activity of the subdivision (temporary bodies), reflect the essence of the problems that are being solved by the subdivision, specify the direction and nature of their activities.

Step 6

Include the sections "Functions", "Rights and responsibilities" and "Relationships" in order to clearly define the tasks performed by this or that body (service), delimit information and documentation flows passing between services, indicate the position of the body in the service hierarchy, identify responsible officials persons for certain official actions.

Step 7

The stamp of approval can be located either on the position itself, or approved by another (separately drawn up) document. Mark the place for it, as well as for the signature of the authorized person and the approval visa (if it is required within the meaning of the document). Sign the document with authorized persons and certify it with the company seal.

Recommended: