• 开发文档模板
  • 介绍
    • 适用人员
    • 开发环境
    • 相关背景
    • 功能概述
  • 项目引用
    • 内部相关
  • 开发详情
    • 功能设计和流程
    • 代码架构和实现
    • 关键点
    • TODO
  • 测试用例
    • 测试环境配置
    • 测试流程和测试结果
  • FAQ

开发文档模板

介绍

适用人员

使用开发人员即需要具备的技能

开发环境

依赖的的开发环境和如何检查

相关背景

此项开发的技术背景和使用场景

功能概述

如何配置和使用功能

项目引用

此项目参考文档

• wiki-markdown

内部相关

内部开发的redmine， 提交等

开发详情

功能设计和流程

功能的软件架构，流程图，时序图等

代码架构和实现

关键点

TODO

遗留的问题和后续开发计划，可以继续优化或者增强的点

测试用例

测试环境配置

测试流程和测试结果

FAQ

描述可能会出现的问题，如何检查和处理