STM32 and motor development (from architecture diagram to documentation)

【 Statement ： copyright , Welcome to reprint , Do not use for commercial purposes . Contact mailbox ：feixiaoxing @163.com】

        Many students don't like writing documents , I always feel that writing documents delays things , Impact on development efficiency . actually , That's not necessarily the case . In actual development , The purpose of writing documents is mainly to clarify their own ideas , Consider everything before developing code , Prevent code from being written in half , The situation that needs to be overturned and restarted occurs .

        Of course , Many times, writing documents is really boring , So is there any good way , It can make document writing a little easier , The answer is to write an architecture diagram first . Because the document itself can be regarded as an architecture diagram + The format of the text .

1、 Write the architecture diagram first

        Architecture diagram is the soul of software . After we get the software development requirements , The first step is to split the module 、 Process abstraction and interface design . You can find some suitable software to complete this part , such as visio、openoffice draw、processon Fine . All in all , As long as the goal can be achieved . For example, we write a website , Then you can draw a simple flow chart ,

2、 Add text to the flowchart

        With the flow chart , Or after the architecture diagram , The next thing to do is to organize words to describe this figure . Which modules can this requirement be divided into , What is the function of each module , What is the relationship between modules , What is the commonly used framework , What usage habits do users have , This part can be written .

        A lot of times , In order to avoid boredom , In the process of writing text, you need to add a directory 、 Revise history 、 For the reader 、 Noun abbreviation 、 form 、 The formula 、 Algorithm pseudocode 、 References . With these contents , You can enrich the document all at once . Explain one thing clearly , You can draw graphics from different angles , It's all right , Mainly to clarify the problem .

3、 The most important thing is the interface

        Part of the algorithm , Generally, everyone will pay attention to . But the interface , Especially the interface of the module 、 Function interface 、 Interface of configuration parameters 、 Database interface 、 Network interface , This part often ignores . Nowadays, software development is getting bigger and bigger , Many times, not all functions can be completed by one person . therefore , For different people , In addition to knowing the position of your own development module in the whole software system , Another part is the software interface , Or module interface .

        The module interface can be divided into two parts , First of all , What is the input of the module , What parameters are needed ; second , What is the output of the module , What functions can the module provide to others . In actual development , Also pay attention to the specific interface technology , yes 485、ethernet, still can, This depends on the specific environment .

4、 Documents must be read and kept fresh

        The document is finished , It doesn't mean that it's over . In the follow-up, new software requirements are put forward , Or when software changes occur , Document update must be indispensable .0.1 edition 、0.2 edition , In this way, software documents need to be maintained and updated constantly . The longer the time , The reuse value of documents will be higher and higher , There is no need to push it down every time , Therefore, the opportunity for the corresponding developed code to be reused will be greater and greater . The corresponding software will become more and more robust , These are the inevitable results that will happen over time . In a word , This is the compound interest effect of time .