如何写好技术文档

  1. 原型设计文档
  • 线框图
  • balsamiq mockups
  • designed for collaboration
  1. UI设计文档
  • Zeplin
    1. 自动标注
    2. Style Guild
    3. 自动换算
    4. 在线存储
    5. 备注评论
    6. 支持sketch /PS
  1. 技术设计文档

  • 设计概况

    1. 涉及领域
    • 模块/领域
    • reviewer
    • approved
    1. 设计准备
    • 描述问题
    • 预期目标，人力/时间等约束

  • 设计详情

    • 层级清晰，先整体后部分
    • 重要逻辑和关键点说清楚
    • 画图
    • 善用表格，分析对比
    • 复杂逻辑使用流程图、伪代码

  • 设计评审

    • Recorder
    • Notes
    • Decision
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成，浏览时请结合常识与多方信息审慎甄别。
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容