写技术文档

关于技术方案设计文档

为何难写？

• 没有规范可依

• 不常写 如何写，技巧：

• 随性一些，解释一下你要如何做，即可

• 可以先尝试写一部分代码，捋一捋思路，再来写文档 —— 【注意】这里写代码纯是为了捋思路、为了写文档，搞清楚目的 写设计文档是浪费时间吗？

• 如果你真的想明白了，最多浪费你 1-2h 时间，不会导致项目延期

• 如果你写不出来，说明你没想明白，正好暴露了问题

文档目录

• 需求背景：把需求文档贴上
• 范围：整体设计，没有细节
• 模块设计
  • 模块拆分和关系图
  • 各个模块的功能解释
  • 特殊模块说明：组件库、统计服务
• 核心数据结构设计
• 扩展性保证
  • 扩展组件
  • 扩展编辑器功能，如锁定、隐藏
  • 扩展页面信息，如增加多语言
  • 扩展其他功能，如大数据分析和计算等
• 研发提效
  • 脚手架：创建发布
  • 组件平台
• 运维保障
  • 线上服务和运维服务
  • 安全
  • 监控和报警
  • 服务扩展性：基于云服务，可以随时扩展机器和配置