前端设计文档

前端设计文档

前端研发流程中 -> 需求阶段 -> 技术调研及方案设计 -> 开发阶段

在需求详评后 需求的功能和交互已经基本确定 确定的技术要点需要补全

• 需求的可实现性
• 需求的整体架构
• 需求的具体设计

设计前端文档, 就是尽快能在开发之前将技术上不确定的点确定好, 将需求的设计方式提前构思好, 以减少后续开发出现风险和问题的可能性.虽然技术文档也不能 100%预见或者评估出所有潜在的风险和问题, 但是技术文档能在相当程度上减少这类风险.

设计良好的前端文档可以帮助你提升开发的质量和效率

确定了代码的整体架构和组件结构, 你就有了构建需求的蓝图 开发就是完成各种组成部分的细节, 这比边干边想效率要高很多

当你在设计时将代码的架构、类型、接口定义好, 开发时甚至可以直接复用设计文档中的代码

而当你完成设计文档以后, 组内同学或者其他合作方就可以了解你的设计, 帮助你判断设计方案的优劣, 了解你方案中对相关方的需求和影响, 可以更高效率的对齐技术信息.

• 求流程的模拟
• 把这个页面或者组件的全部功能列举清楚, 这些页面或组件又有什么样的状态变化和交互, 只有把这些方面考虑齐全了, 才可能更客观的评估工作量的多少.
• 收集齐开发需要的各类文档和资料, 以提升查找所需信息的效率

1. 需求文档
2. 设计视觉稿
3. 服务端 IDL
4. 第三方服务/SDK 文档
5. 测试 Case
6. 埋点文档
7. 运营资源列表(optional)
8. 走查及验收文档

需求背景及资源

• 需求背景
• 相关文档 & 资源
  • 需求文档:
  • 设计视觉稿:
  • 服务端 IDL:
  • 第三方服务/SDK 文档
  • 测试 Case:
  • 埋点文档:
  • 运营资源列表(optional):
  • 走查及验收文档:

排期

需求 Timeline

评审	设计	开发	联调	测试	上线

排期拆分

排期(人/天)	模块 Owner