如何写出一个好的设计文档

1.概要

大部分的工程师都不重视设计文档的书写，对于一个需求，都是经过一些简单的讨论，写一个简单的方案甚至就是自己简单的想想就开始进行编码的工作。

往往这种开发方式会导致开发人员对细节考虑不周，开发过程中会带来许多的坑，在今后采坑或者补坑的路上耗费大量的人力，轻则影响上线时间，重则上线了出现case，影响业务。

写设计文档和是能够帮助开发人员完成 是什么->做什么->怎么做 的思路梳理过程。比如，你可能对一个技术或者概念很熟悉了，但是你在要说出来或者写出来给别人看的时候，或许就会发现有些技术的细节你没有考虑清楚。

当你在写一个设计文档的时候，会逼迫你自己去把每一个细节都弄清楚，想明白。这样，在实际的开发过程中才会少踩坑，不踩坑。

2.好的设计文档需要哪些内容

对于一个设计文档的书写，应该满足STAR原则，同时一个好的设计文档需要考虑业内的各种实现方案，不能闭门造车。

基于此我认为主要会分为8个部分。分别为 项目背景，项目目标，需求分析，方案对比，概要设计，详细设计（存储模型设计，接口设计），开发以及上线计划，方案排期。

对于详细设计中，需要存储应该有存储模型的设计，需要交互应该有相应接口的设计。下面详细说下每个部分的书写要点。

2.1项目背景

主要是梳理下目前系统中的主要问题和痛点，主要问题和痛点的范围覆盖面很广，可以主要从 稳定性、业务、 运营的角度去分析。

• 对于稳定性，具体的问题可以给出相应的数据指标，比