Teach you how to apply for computer software patent copyright (3)-software instruction manual

#Today is also a day for salted fish~

Teach you how to apply for computer software copyright series

1. Fill in the soft application form
2. Generate code file & proof of identity
3. This article
4. Information mailing

To apply for computer software copyright (hereinafter referred to as "software"), a total of four documents must be submitted: identification, design code, application form, and software use (design) documentation.
The first three have been introduced, so this blog will talk about how to write a software manual .
————————————————————————————————————————
Because the blogger himself is a college student, he is The target is also for college students who apply softly. Some of the content will be different from the company's application, and some details are not too detailed. In order to avoid your application mistakes, please do not refer to too many articles to prevent losses.
————————————————————————————————————————

Write software manual

Software use (design) manual introduction

Key points:
For embedded software, hardware code, database code, this kind of software code without a graphical operation interface, what is written is not a "software user manual", but a software design manual. A more detailed explanation is needed for the design ideas of the code.

For software with an operating interface, such as Windows Forms applications, Android applications, and Apple applications, the "software instruction manual" is written. The focus is on the instructions and explanations of use, a bit biased towards the format of the user manual.

For the operating system software and compiler code that college students may seldom apply for, this category includes two parts: use and design, because this is a complex software system that requires a detailed explanation.
——————The
software manual is a document used to describe the content, composition, design, functional specifications, development status, test results and use methods of the program, such as the program design manual, flow chart, user manual, etc.

In the submission, if the document does not exceed 60 pages, submit all; if it exceeds 60 pages, submit the first 30 pages and the last 30 pages.
In most of the supplementary materials submitted for soft work applications, there are problems with the application form and software documentation, so be sure to pay attention to the writing of the software documentation.

Basic requirements of the manual

1. Language: Natural language, as easy to understand as possible, and use less terminology.
2. Page format: header, version number, software name, page number. (The name and version number must be exactly the same as the application form)
3. Number of lines: no less than 30 lines per page, except for pictures.
4. If the content of the document is too much, please write the table of contents. (Most of my college students will not have this problem)
5. The installation process of the software code programming environment can be appropriately added according to the situation. (You taste, you fine taste)
6. Take a screenshot of the software interface, be sure to take a full screen. (Otherwise, you will be beaten back, watch fate)
7. For hardware, if there is a display, you can add a picture of the display to display the information. Or, if you use a serial host computer for data display, you can cut the image of the host computer to help explain the software code function.
8. Specify the software operating environment to facilitate users to accurately match the equipment.
9. Combine pictures and texts, but not too many pictures, just look natural.
10. There are detailed operating procedures, detailed to the kind of hands-on.
11. The picture cannot contain mosaics, horizontal bars and other obstructions that cover the content of the screenshot. The picture is required to be clear after printing

Experience

1. The thinking must be clear and the explanation must be detailed. If there is a formula, be sure to list the formula and make another explanation. For those with an interface, every function must be explained in place, just as teaching Xiaobai to use this, starting from 0. For those who call library functions, we should also introduce the functions of this library function together. If there is a principle, the principle should also be explained.
   In short, the more detailed the better.
2. Regarding whether to write the installation process of the IDE or EDA that writes the code, this can be written or not. It is icing on the cake, and there is no big problem if it is not written.
3. If the software you write requires an installation process, be sure to elaborate on the installation process, taking screenshots of each process.
4. Grasp the level, when describing, write a sense of progressiveness.
   For example:
   first, like this, then, secondly, in, so, there is, there is, finally.
   Regarding this, it is so, it brings results, has an impact, and what happens.
   What was used, realized one, showed the effect, made...
5. Don't use too much colloquial content. On the basis of natural language, describe as rigorously as possible to avoid semantic errors.
6. Try to avoid the appearance of personal pronouns. The first, second, and third-person pronouns should appear as little as possible, especially for sentences that begin with me, us, and you. It is better to use terms like users, users, operators, engineers, and administrators that describe the characteristics of the software. (It's a bit slurred, but that's what it means)
7. Pay attention to the use of fonts.
8. The size of the pictures should be as consistent as possible to ensure that they are beautiful and to prevent others from calling you back because of this.

———————————————————— Finished dividing line————————————————————

Different people have different writing contents of the software manual, so I won't put pictures here to mislead people. You can find many templates on the Internet. Just write one copy.
The main thing is to pay attention to the requirements of the official website and avoid detours. If you make a mistake, it will be troublesome to send the materials.

There is a requirement on the Internet that for codes below 6000 lines, at least 5 pages of instructions, and at least 15 pages for codes above 6000 lines. Not sure if this is correct, please check it yourself.

The content written in the blog is based on my own experience. It is not guaranteed that the content is 100% correct. If there are any errors, please correct me. Thank you very much.