name: 文档 description: 从实现的变更中生成简洁的功能文档。在完成功能后使用，以捕获所构建的内容供未来参考。 argument-hint: [adw-id] [spec-path] allowed-tools: Read, Write, Glob, Grep, Bash

生成功能文档

从实现的变更中生成简洁的Markdown文档。

变量

adw_id: $1 - 工作流标识符（可选）
spec_path: $2 - 原始规范路径（可选）

目的

文档回答：“它是如何工作的？”

为已实现的功能生成参考文档，供未来的代理和开发人员使用。

指令

1. 分析变更

理解所实现的内容：

# 查看变更摘要
git diff origin/main --stat

# 列出更改的文件
git diff origin/main --name-only

# 查看重要文件的详细更改
git diff origin/main -- path/to/file

2. 阅读规范（如果提供）

如果提供了spec_path：

理解原始需求
围绕“请求的内容 vs 构建的内容”构建文档
注意任何偏差或增强

3. 生成文档

创建文档文件：docs/feature-{描述性名称}.md

文档格式

# [功能标题]

**日期**: [当前日期]
**规范**: [spec_path 或 N/A]

## 概述

[2-3句话总结所构建的内容]

## 所构建的内容

- [组件/功能 1]
- [组件/功能 2]
- [组件/功能 3]

## 技术实现

### 修改的文件

- `path/to/file.ts`: [变更的简要描述]
- `path/to/other.ts`: [变更的简要描述]

### 关键变更

- [重要的实现细节 1]
- [重要的实现细节 2]

## 如何使用

1. [使用功能的步骤 1]
2. [使用功能的步骤 2]

## 配置

[环境变量、设置或选项（如果适用）]

## 测试

[如何测试此功能]

## 备注

[任何额外的上下文、已知限制或未来考虑]

4. 更新条件文档（如果适用）

如果存在条件文档，为新文档添加条目：

- docs/feature-{名称}.md
  - 条件：
    - 当处理[功能领域]时
    - 当实现[相关功能]时

输出

仅返回创建的文档文件路径：

docs/feature-export-to-csv.md

最佳实践

简洁: 文档应易于扫描
准确: 反映实际构建的内容
可操作: 包括如何使用功能
当前: 随着功能变化保持更新
链接: 引用相关文档

文档作为反馈循环

“文档为已完成的工作提供反馈，供未来的代理在其工作中参考。”

良好的文档使能：

未来的代理理解代码库
开发人员更快上手
遵循一致的模式
知识在会话间持久化

与工作流的集成

文档通常在评审之后：

/plan → /implement → /test → /review → /document (此命令)

文档是捕获所构建内容的最后一步。