Back to Details

project-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Project Docs

项目文档

This skill helps you keep documentation correct, minimal, and aligned with the codebase.
这个Skill可帮助你保持文档准确、精简，并与代码库保持一致。

What To Document

需要记录的内容

  • User-facing behavior changes
  • New CLI flags, environment variables, configuration changes
  • Protocol/API changes, request/response shapes
  • Operational guidance (troubleshooting, limitations, safety workflows)
  • 用户可见的行为变更
  • 新的CLI标志、环境变量、配置变更
  • 协议/API变更、请求/响应格式
  • 操作指南（故障排除、限制、安全工作流程）

Doc Update Workflow

文档更新流程

  1. Identify the code changes and their user-visible effects.
  2. Locate the canonical docs (README vs guides vs references).
  3. Update docs with minimal churn, matching existing style.
  4. Cross-check examples against current CLI help / code.
  5. Run relevant tests and include them in the update note.
  1. 识别代码变更及其对用户可见的影响。
  2. 找到规范文档（README、指南还是参考文档）。
  3. 以最小的改动更新文档，匹配现有风格。
  4. 对照当前CLI帮助/代码交叉检查示例。
  5. 运行相关测试并将其包含在更新说明中。

Consistency Checks

一致性检查

  • Option names match actual CLI flags (
    --help
    output if available).
  • Defaults are correct and stated once (avoid duplication across docs).
  • Examples are runnable and do not rely on project-private paths.
  • Terminology is consistent across README/guides/references.
  • 选项名称与实际CLI标志匹配（如果有
    --help
    输出）。
  • 默认值准确且仅声明一次（避免在文档中重复）。
  • 示例可运行且不依赖项目私有路径。
  • 术语在README/指南/参考文档中保持一致。

Subagent Invocation (docs-excellence-architect)

子代理调用（docs-excellence-architect）

Use the Task tool to delegate a doc-focused review to a specialized subagent:
  • subagent_type: 
    docs-excellence-architect
Provide:
  • The doc files to touch
  • The code changes that need to be reflected
  • The desired doc structure (where each piece should live)
Example prompt:
Review and update docs for the following changes:
- <change 1>
- <change 2>
Target files:
- README.md
- guides/*.md
- docs/*.md
Constraints:
- Minimal churn, match local style
- Ensure examples are accurate and consistent
Deliverables:
- Proposed edits (diff-style)
- A checklist of what was verified
使用Task工具将文档相关的审查委托给专业子代理：
  • subagent_type: 
    docs-excellence-architect
提供以下信息：
  • 需要修改的文档文件
  • 需要在文档中体现的代码变更
  • 期望的文档结构（各内容应放置的位置）
示例提示：
Review and update docs for the following changes:
- <change 1>
- <change 2>
Target files:
- README.md
- guides/*.md
- docs/*.md
Constraints:
- Minimal churn, match local style
- Ensure examples are accurate and consistent
Deliverables:
- Proposed edits (diff-style)
- A checklist of what was verified

Maintenance Guidelines

维护准则

  • Prefer short sections with concrete examples.
  • Avoid repeating the same definition in multiple files.
  • When a doc becomes a reference, move it to a single canonical location and link to it.
  • 优先使用包含具体示例的短章节。
  • 避免在多个文件中重复相同的定义。
  • 当文档成为参考资料时，将其移至单一规范位置并添加链接。