---
title: 功能专项说明模板
doc_type: template
domain: documentation
keywords:
  - 功能说明模板
  - 专项说明模板
  - 文档模板
summary: 新建功能专项说明时，从这里起稿并替换占位符，保持统一的渐进式披露结构。
when_to_read:
  - 要新增某个功能专项说明
  - 想保持专项文档的头部元信息和阅读顺序一致
read_next:
  - ../features/README.md
  - ./feature-functional-test-template.md
---

# 功能专项说明模板

这份模板用于起草功能专项说明。使用时先改掉头部 frontmatter，再替换正文里的占位符和示例链接，最后补上对应的运维或功能测试文档。

如果你正在阅读这篇文档，说明你现在关注的是“<功能名称>”这条专项链路，而不是整个项目的全局背景。

## 按角色进入

| 如果你现在更像谁 | 建议先读什么 | 读完再看什么 |
| --- | --- | --- |
| 前端 / 桌面交互开发 | 本文的 `当前实现`、`已知边界` | [功能测试文档](../operations/<feature-name>-functional-test.md) |
| Rust / 数据链路开发 | 本文的 `当前状态`、`关键链路` | [项目架构](../overview/architecture.md) |
| 测试 / 回归验证执行人 | [功能测试文档](../operations/<feature-name>-functional-test.md) | 本文的 `当前状态` |
| 想先理解业务语义的人 | [项目业务总览](../business/README.md) | 本文的 `背景` |

## 按任务进入

| 如果你现在想做什么 | 先看哪部分 |
| --- | --- |
| 先理解为什么这个功能值得单独成文 | `背景` |
| 快速确认现在已经落地到什么程度 | `当前状态` |
| 看清链路里缺的到底是哪一层 | `一图看懂`、`已知边界` |
| 对照当前仓库已经有了哪些结构件 | `当前实现` |
| 按步骤回归验证 | [功能测试文档](../operations/<feature-name>-functional-test.md) |

## 本文职责

| 本文只负责什么 | 本文不负责什么 |
| --- | --- |
| 解释这个功能为什么要这样设计 | 整个项目的全局业务背景 |
| 说明这个功能当前已经迁入了什么、还缺什么 | 全部系统边界 |
| 固定该专项的设计判断、契约和结构缺口 | 逐步操作型测试手册 |

如果你现在要看全局业务背景，回到 [项目业务总览](../business/README.md)。如果你现在要跑回归测试，直接去 [功能测试文档](../operations/<feature-name>-functional-test.md)。

## 背景

这份文档解决的是一个具体问题：

- 这个功能为什么值得单独成文
- 它和对照实现、历史实现或当前架构之间的关系是什么
- 当前最容易反复出错的点在哪里

## 当前状态

截至 YYYY-MM-DD，这条链路已经补齐到下面这个状态：

- 已实现：
- 已对齐：
- 已修复：

当前仍然没有完整承接的部分：

- 待补齐：
- 待统一：

## 一图看懂

```mermaid
flowchart LR
    A["当前输入"] --> B["当前功能链路"]
    B --> C["当前输出"]
```

这张图表达的重点是：

- 
- 
- 

## 当前实现

### 1. 入口层

说明页面、API、bridge 或命令入口已经做到什么程度。

### 2. 数据或状态层

说明表结构、状态模型、缓存或读模型已经做到什么程度。

### 3. 后台执行链路

说明调度、任务、回写、日志或恢复机制已经做到什么程度。

## 已知边界

### 1. 当前还没接入的部分

- 

### 2. 当前容易误解的部分

- 

### 3. 当前不建议怎么改

- 

## 对后续改动最重要的结论

1. 
2. 
3. 
