前端开发-技术设计文档编写规范

目录大纲

PS:

李开复老师在《浪潮之巅》的序言中说到：“我认识很多顶尖的工程师，但具备强大叙事能力的优秀工程师，我认识的可以说是凤毛麟角”。表达是软件开发工程师重要的软实力之一，作为软件工程的最佳实践，方案设计在前端开发过程中还是十分必要的.

前端人员的抽象思维和工程化能力总体还是比后端弱的；但是这些原因其实都不是我们不做方案设计的理由，方案设计是个结构化思维的过程，他不光是能让项目更好执行，也能提升开发者本身的架构能力和宏观意识。我们要把自己做的东西展示出来，不光展示给同行看，可能还要展示给其他岗位上的工作人员看，甚至展示给用户看。如果我们只是会写程序，不会在文档中恰当且优雅地描述自己的想法，那么就真正的成为“码农”了。

一、说明项目结构 & 代码结构
二、说明整体思路 & 流程图
三、对于特殊处理 & 复杂处理的地方进行说明
四、对于引用的复杂组件进行说明
五、对于自己抽取的组件进行说明

目的性

1.对于开发任务前大脑的构思和结构梳理, 进行实质化的文档落地.
2.输出简介、准确且有条理性的文档及API, 提升自己的总结、归纳能力, 快速复盘.
2.提升工作、任务交接、后期维护的友好性.
3.锻炼自己的架构设计能力和宏观意识.

内容要点:

1.项目署名 - 作者信息
2.背景&业务需求 - 概述为了解决什么问题&需求
3.必要的接口说明 - 入参、反参, 响应之后的业务逻辑控制
样例:

4.TODO项说明当前开发&迭代预留、待完善点
5.重点说明

相关站点:

1.https://juejin.cn/post/6844904200833335309
2.https://blog.csdn.net/xgangzai/article/details/122150885