需求文档写作规范

1. 项目创建

一般情况,一个服务要有一个需求文档的git项目。即需要在gitlab docs 组织下建立与之对应的项目仓库

例如创建一个需求文档的项目。

文件结构

2. 版本管理

需求文档基于git分支进行版本管理。

默认情况下,创建一个git项目都会有一个master分支。我们并不在master分支上写任何需求。

我们根据项目的版本来创建分支。例如我们先创建一个v1.0.0的分支,我们在该分支上写需求文档。当v1.0.0版本发布后,我们基于v1.0.1分支。 而且我们能够自由的切换分支。

3. 需求状态

需求有以下几种状态,

  • 开始(draft), 草稿阶段
  • 需求稳定(stable), 需求标记为stable, 开发才着手开始开发
  • 需求修改(modified), 需求处于修改状态,则开发暂停
  • 开发(dev), 开始开发
  • 测试(test), 开始测试
  • 发布(released), 测试通过,开始发布

4. 格式要求