Experience: How to Develop product manuals with promotional colors

The ERP system that lasted for more than half a year has finally ended, and the Business analyzed in the early stage has come to an end, so we have to proceed to the next step. Although the customer was trained, there was no complete product manual for the customer to query and use, so this arduous task fell onto me. This task can only be written after I go back to Beijing on a business trip. After I come back, my company's organizational structure has been divided. Although my position has been improved, there are more and more things. Fortunately, after a week of rectification, I can write a manual, I don't know if writing is really a simple task. Although I don't have much technical skills, I still have a considerable workload. After writing for a few days, I felt a little touched. Today, the local server has some problems. Now I have time to sort out my ideas, write down some of my experiences in writing a manual these days.

Writing a product manual requires no comprehensive understanding of the overall business system and clarifying the relationship between various business subsystems. In this way, the written manual is a live manual, the next step is not just a simple one. Next, I will summarize the major frameworks of my manual, add a description of each module framework, and summarize one of my work over the past few days, it is also designed to improve the basic performance in the subsequent writing process.

First,SYSTEM INTRODUCTION

Before writing the manual function, you need to give a general introduction to the current ERP system, including: company information, system functions, general system procedures, benefits to the company through the use of the system, and finally introduce the system installation and access forms and system architecture information. The above information is basically enough. The length does not need to be too long. It is simple and clear.

Second,System features and advantages

Combining the functions of the system, we can draw out the highlights and advantages of the system and describe them day by day. This also paves the way for system publicity, in addition, this is a good place to show the differences between the system and others. This part may not be easy to write, but it must also be written, because it is a system advantage and must be taken seriously.

Third,System Rules

Each software system must have a rule description, just as before playing the game, you must first understand the game rules, otherwise the game cannot proceed. The same applies to software. before using the software, you must first understand the rules to be followed when using the software system. For example, document encoding rules, digital identities that should be followed during use, and other rules.

Fourth,Features

After the above three sections are described, we will detail each module of the system. This section is also the most labor-intensive part. Generally, it is written in multiple parts:

ÜBusiness Architecture diagram:

Before introducing the various modules of the system, first introduce the system as a whole with a chart, including: database, use platform, intermediary business, front-end access terminal form, etc. Below is the Business Architecture diagram of our system:

ÜModule Introduction:

The module Introduction focuses on the detailed usage of each module in the system, which is divided into several parts:

Primary Role

This section describes the roles used or used to use the current module.

Main documents involved

The document information involved in the current module, such as the contract.

Module functions

A General Introduction is provided to the main functions of the current module. before using this function, let everyone know what the main functions of the current module are.

Procedure

The function buttons involved in the current module are described one by one, including the functions, operation steps, what to do in the first step, and what to do in the second step, which are clearly written one by one, it plays the best role for those who have never used the system to use the system by looking at the operation steps.

Precautions

The items that should be paid attention to during current function operations, such as required items.

After completing the above five steps, the introduction of a module is complete. Then, we will introduce the corresponding modules one by one based on the above model. In addition, if there are multi-level small modules in the module, it is best to use the title format to write, so that when you see your title, it will correspond to the system menu item. This allows you to quickly and accurately find relevant manuals during use for reference.

Fifth,Typical users

After the introduction of the above four parts of the system, the current system manual is basically completed. In order to achieve the promotion effect, we will add some typical users who use the system here, it can enhance the system's persuasiveness and publicity effect.

Sixth,About us

I would like to introduce our software company here, so that we can have a simple understanding of the companies we hope to cooperate with. Of course, the information here should be concise and not concise, this section describes our strengths and scope of service.

7,Contact info

All the above aspects have been described. Finally, we need to introduce the contact information of software companies so that potential user groups can find us more conveniently.

After writing so much, I have finally finished writing my summary over the past few days. Of course, I hope to share with you some new breakthroughs and experiences in the subsequent manual writing process. Write it down here, and try to make a general summary for your work back in Beijing.