image

Development Guide

开发指引

• Environment Setup —— 开发环境搭建
• Microservices —— 微服务架构图
• Deployment —— 项目部署清单
• Standards —— 开发规范
  • Git-Flow —— 分支规范
  • Coding —— 代码规范
  • …

备：如有公共文档，可在团队文档中添加 Link

Business Diagram

业务图表（Flowchart / UML / Map / Graph / …)

以架构的视角，对 Product Design 补充技术说明，图表需要备注关键说明，例如：业务条件、技术细节、数据处理…

就像将 Story 拆分成 Features，视角不一样，内容也有所不同！

Technical Documentation

技术文档

业务背后的技术方案，例如：架构图、微服务、Redis 锁、队列、路由、第三方对接…

User Manual

用户手册

• Business Glossary —— 业务术语
• Service Context —— 服务上下文（图表说明）
• Module —— 业务模块
  • Module A
    • Component A
      Content —— 以小白用户的视角讲解产品（检验产品是否易用）
      • Description —— 业务说明
      • FlowChart —— 业务流程（可共用 Business Diagram 建立的 Draw）
      • Operation —— 业务操作（操作步骤、图文说明、Gif 更佳）
      • FAQ —— 常见问题
    • Component B
    • Component C
    • …
  • Module B
  • Module C
  • …