How to write a client-side technical solution

One 、 background

As a developer , After every requirement Review , The first thing is to do technical solutions , Today, let's take my usual idea of making technical solutions , Write down how to write a good technical solution . The scheme template will be attached below , Those with different views can comment and communicate .

Two 、 Why write a technical proposal

The first thing to be sure is , Writing technical solutions is a must .

Insufficient before 500 People work in small companies , For a demand , After the requirements review , The scheduling will be given directly , Then the R & D team will complete each module . The end result is ：

1. app Each module has its own style , There is no unified way of writing , Later maintenance is very inconvenient .
2. The calling methods between modules are not unified , It is inconvenient to call later , It may need to be redeveloped .
3. During the joint debugging , Each end cannot be connected in series , Maybe the functions of the interface that the client wants to implement are inconsistent with those of the interface provided by the back end .
4. Various repairs , Obviously bug Count hundreds .
5. Finally, it takes a lot of energy , As a result, the project was delayed , Code has also become one-time code , There is no scalability and robustness to talk about .

Through the above results ：

In my submission , The technical proposal needs to be written , The technical proposal is well written , Especially in terms of joint commissioning and overall architecture , Can avoid many pits .

3、 ... and 、 What points should be paid attention to when writing a technical proposal

• Judge whether the demand is reasonable , Whether there are benefits , If demand has no benefit , That's a waste of manpower , You can give feedback directly to the product , Do not accept the demand .
• To meet the needs , Meet the needs of the environment , Be scalable — Consider later iterations of this requirement , Do extensible architecture （ for example ： Open screen advertisement -- Consider different ways of clicking and skipping （ Shake and jump 、 Slide up and jump 、 Click the button to skip and so on ）, Be scalable ）.
• According to the online cycle of demand , To determine whether to introduce some new 、 Difficult 、 Time consuming Technology . If time is urgent , The development time needs to be pushed back through the online time , Then the time cost needs to be considered more .
• Management plan , Communicate with products in advance , What do you need , What data do you want .
• Whether you need to join AB, To do degradation processing .
• Cross departmental collaboration , Whether all interfaces are provided .
• Scheme during grayscale – Guarantee quality .

Four 、 Technical proposal template

The following is a template I usually write technical solutions , Share it .

1、 Technical documentation describe

1.1、 Relevant members of the project team

Mainly the technology of each team owner, For cross team collaboration , It is convenient to find the corresponding person later , To communicate .

1.2、 Design preparation

1.2.1、 Requirements and product design

Here you can post Product requirements documents and related design documents

1.2.2、 Expected earnings

Here is mainly about the positive results and obvious benefits of this demand

1.2.3、 Pre Development Research

Research relevant technical points in the early stage of development , Whether it can be realized , Achieve the effect and what are the difficulties , It can be written here , Later, you can throw it out and communicate with other team members .

2、 Detailed design

2.1、 Architecture description

Here you can attach relevant architecture diagrams, relevant business process diagrams, and diagrams related to data models .

2.2、 Implementation details

Here we mainly write the implementation details of each module , And sequence diagram , And the definition and description of the external interface
Pseudo code or important code of related nodes , Or the interface provided externally Can be exposed .

2.3、 External dependence

Mainly describe other teams , Including the technical dependence of upstream and downstream and partners , This is to confirm whether the relying party has corresponding resources for us , When can we rely on when we can not block our normal development .

2.4、 Manage relevant

In fact, it's about managing needs , Is there any dot , What is the goal of management , What states do you want to detect . This also needs to communicate with the data teacher , See if you need to create a new report to monitor .

3、 Time limit

List the duration of project personnel and each time node

4、 test

Test cases can be pasted here , And related test methods , The test of mock etc. . Convenient for later self-test and test

5、 Technical review

Relevant problems found in the technical review , It's recorded here TODO Solve it after the meeting . And resynchronize it to the participants .

5、 ... and 、 Share the overall process of production and research