⚡

条件文档设置技能Skill conditional-docs-setup

这个技能用于设置条件文档加载系统，以防止在软件开发项目中上下文污染。它通过根据任务条件动态加载相关文档，优化文档管理，提高开发效率和专注度。适用于组织项目文档、实现渐进式披露或减少文档令牌消耗。关键词包括：条件文档、上下文污染、文档加载、项目文档管理、软件开发优化、DevOps工具。

DevOps 0 次安装 0 次浏览 更新于 3/11/2026

name: 条件文档设置技能 description: 设置条件文档加载以防止上下文污染。在组织项目文档、实现渐进式披露或通过按需加载减少CLAUDE.md令牌消耗时使用。 allowed-tools: 读取, 写入

条件文档设置技能

设置条件文档加载以防止上下文污染。

何时使用

  • 设置新项目的文档
  • 减少现有项目中的上下文污染
  • 创建即时文档加载
  • 优化代理上下文使用

核心概念

仅当条件匹配当前任务时加载文档。

“重要：仅当您的任务匹配任何条件时读取文档。”

设置工作流程

步骤1：清单文档

列出项目中的所有文档文件：

# 查找文档文件
find . -name "*.md" -path "*/docs/*"
find . -name "README*"
find . -name "CONTRIBUTING*"

步骤2：按目的分类

按帮助内容分组文档：

类别 示例
设置 README, INSTALL, CONTRIBUTING
API api-reference, endpoints, schemas
架构 design-docs, system-overview
功能 特定功能指南
测试 测试模式, fixtures

步骤3：定义加载条件

为每个文档，识别何时相关：

- docs/api-reference.md
  - 条件：
    - 当使用API端点时
    - 当添加新路由时
    - 当修改请求/响应格式时

- docs/database-schema.md
  - 条件：
    - 当修改数据库表时
    - 当添加新模型时
    - 当编写迁移时

步骤4：创建条件文档文件

创建条件文档清单：

# 条件文档

这有助于根据您需要在代码库中做出的特定更改来确定要读取的文档。

重要：仅当条件匹配您的任务时读取文档。

---

- README.md
  - 条件：
    - 当首次理解项目时
    - 当设置开发环境时

- docs/api/endpoints.md
  - 条件：
    - 当使用REST端点时
    - 当添加新API路由时

- docs/database/schema.md
  - 条件：
    - 当修改数据库表时
    - 当创建迁移时

- docs/testing/patterns.md
  - 条件：
    - 当编写新测试时
    - 当调试测试失败时

步骤5：集成到命令中

将条件文档检查添加到规划命令：

## 相关文档

读取 `.claude/commands/conditional_docs.md` 以检查您的任务是否需要额外文档。如果您的任务匹配任何列出的条件，包括那些文档文件。

条件编写指南

具体

# 好 - 具体条件
- 当添加新API端点时
- 当修改用户认证时

# 坏 - 模糊条件
- 当进行后端工作时
- 当编码时

覆盖常见场景

- docs/auth.md
  - 条件：
    - 当实现登录/注销时
    - 当添加新权限时
    - 当调试认证问题时
    - 当集成OAuth时
    - 当使用会话时

避免重叠

每个文档应有不同的条件：

# 好 - 不同条件
- api-reference.md → API端点
- database-schema.md → 数据库表

# 坏 - 重叠条件
- api-reference.md → 当进行后端工作时
- database-schema.md → 当进行后端工作时

维护工作流程

当添加文档时

  1. 创建新文档文件
  2. 添加到 conditional_docs.md
  3. 定义适当的加载条件

当更新文档时

  1. 审查现有条件
  2. 根据需要添加/移除条件
  3. 更新文档内容

当移除文档时

  1. 删除文档文件
  2. 从 conditional_docs.md 中移除条目

模板：条件文档文件

# 条件文档

这有助于根据您需要在代码库中做出的特定更改来确定要读取的文档。

重要：仅当条件匹配您的任务时读取文档。
过多文档加载浪费上下文并减少专注度。

---

## 项目设置

- README.md
  - 条件：
    - 当首次理解项目时
    - 当设置开发环境时
    - 当学习可用命令时

## 后端

- docs/api/reference.md
  - 条件：
    - 当使用API端点时
    - 当添加新路由时

- docs/database/schema.md
  - 条件：
    - 当修改数据库表时
    - 当编写迁移时

## 前端

- docs/components/guide.md
  - 条件：
    - 当创建新组件时
    - 当修改UI模式时

## 测试

- docs/testing/patterns.md
  - 条件：
    - 当编写测试时
    - 当调试测试失败时

内存参考

  • @conditional-docs-pattern.md - 完整模式文档
  • @minimum-context-principle.md - 为什么这重要
  • @one-agent-one-purpose.md - 上下文影响专注度

版本历史

  • v1.0.0 (2025-12-26): 初始发布

最后更新

日期: 2025-12-26 模型: claude-opus-4-5-20251101