需求管理入门

Zephyr 的需求管理由 StrictDoc 提供支持，这是一个用于编写、组织和发布结构化需求的轻量级工具。本节介绍如何设置和使用 reqmgmt 仓库中提供的工具链。

概述

reqmgmt 仓库是 Zephyr 的官方需求工作区。它支持：

• 编写系统需求和软件需求

• 将需求与验证产物关联

• 生成可浏览的 HTML 文档

• 运行用于编辑和评审的本地 Web 界面

安装

StrictDoc 需要 Python 3.7 或更高版本。安装方法如下（你可能需要使用 pip3 代替 pip）：

pip install strictdoc

克隆 Zephyr 需求仓库：

git clone https://github.com/zephyrproject-rtos/reqmgmt
cd reqmgmt

用法

将需求导出为 HTML：

strictdoc export .

这将在 output/ 目录中生成一个静态站点。

启动本地 Web 界面：

strictdoc server .

你应该会看到类似以下内容的输出

Uvicorn running on http://127.0.0.1:5111 (Press CTRL+C to quit)

打开本地浏览器并粘贴上述地址，即可访问基于浏览器的编辑器，浏览和编辑需求。

结构

仓库包含：

• docs/ — 按子系统组织的需求文档

• strictdoc.toml — StrictDoc 的配置文件

• tasks.py — 用于构建和验证需求的自动化辅助工具

在线文档

你可以通过以下地址在线查看已发布的需求：

https://zephyrproject-rtos.github.io/reqmgmt

后续步骤

• 浏览 docs/ 文件夹，查看需求文件示例

• 使用 Web 界面创建或编辑自己的需求文件

• 将需求与测试用例或源代码模块关联，以实现可追溯性

StrictDoc 通过将系统目标与软件实现之间的关联形式化，帮助 Zephyr 逐步具备支持安全关键应用的能力。