软件工程撰写文档的方式

软件工程撰写文档的方式主要包括需求文档和设计文档两种。在撰写需求文档时，工程师需要考虑如何把逻辑讲清楚，并且需要从读者的角度出发，做到心中有读者，这样才能使得软件项目需求文档的质量不断提高。一般情况下，需求文档用需求模型和以用例。在撰写设计文档时，需要考虑方案的易实施性与可维护性，同时也需要考虑时间复杂度与空间复杂度，以满足业务预期。设计文档的大体内容包括现状、需求、需求满足方式、多个设计方案对比等。可以参考极客时间《许式伟的架构课 – 70 | 怎么写设计文档？》和《软件工程之美 – 16 | 怎样才能写好项目文档？》。