Back to Details

documentation-writer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Documentation Writer Skill

文档编写Skill

You are writing or updating project documentation. This skill ensures you follow project conventions and maintain consistency.
你正在编写或更新项目文档。该Skill可确保你遵循项目规范并保持一致性。

When This Skill Activates

该Skill的激活场景

This skill activates when you are:
  • Creating new documentation files in 
    docs/
  • Editing existing documentation in 
    docs/
  • Updating 
    docs/INDEX.md
  • Working on domain, feature, or layer documentation
  • Updating documentation as part of code changes
当你进行以下操作时，该Skill会被激活：
  • 在
    docs/
    目录下创建新的文档文件
  • 编辑
    docs/
    目录下已有的文档
  • 更新
    docs/INDEX.md
    文件
  • 编写领域、功能或层级相关文档
  • 随代码变更同步更新文档

Load Documentation Conventions

加载文档规范

Before writing any documentation, load the project's conventions:
Use Glob to find: .claude/rules/documentation/**/*.md
Read each file found
These files define:
  • Documentation structure (domains, layers, features)
  • File-to-doc mapping conventions
  • Templates for different documentation types
  • Writing style guidelines
  • When to create documentation
  • INDEX.md maintenance rules
在编写任何文档之前，请加载项目的规范：
Use Glob to find: .claude/rules/documentation/**/*.md
Read each file found
这些文件定义了：
  • 文档结构（领域、层级、功能）
  • 文件与文档的映射规范
  • 不同类型文档的模板
  • 写作风格指南
  • 文档创建时机
  • INDEX.md的维护规则

Follow the Conventions

遵循规范

All documentation practices are defined in 
.claude/rules/documentation/
. Your job is to:
  1. Load the conventions first
  2. Follow the structure defined there (domains, layers, placement)
  3. Use the templates provided for consistency
  4. Maintain INDEX.md as specified in conventions
  5. Follow style guidelines for clarity and completeness
所有文档编写规范都定义在
.claude/rules/documentation/
目录下。你的工作内容包括：
  1. 优先加载规范
  2. 遵循其中定义的结构（领域、层级、存放位置）
  3. 使用提供的模板以保持一致性
  4. 按照规范要求维护INDEX.md
  5. 遵循风格指南，确保文档清晰完整

Critical Reminders

重要提醒

  • Always update 
    docs/INDEX.md
     when creating new documentation
  • Check INDEX.md first before creating docs (might already exist)
  • Use lowercase-with-hyphens for file names
  • Include code references with line numbers: 
    path/to/file.php:123
  • Link generously between related documentation
  • 创建新文档时务必更新
    docs/INDEX.md
  • 创建文档前先检查INDEX.md（可能已存在相关内容）
  • 文件名使用小写连字符格式（lowercase-with-hyphens）
  • 包含带行号的代码引用：
    path/to/file.php:123
  • 在相关文档之间添加充足的链接

Integration with Other Skills

与其他Skill的集成

This skill works alongside:
  • backend-developer - When backend code changes need doc updates
  • frontend-developer - When frontend code changes need doc updates
  • research-agent - Provides context for documentation gaps
  • process-documentation-reports - Uses this skill when generating docs
该Skill可与以下Skill协同工作：
  • backend-developer - 当后端代码变更需要更新文档时
  • frontend-developer - 当前端代码变更需要更新文档时
  • research-agent - 为文档缺失部分提供上下文信息
  • process-documentation-reports - 生成文档时会使用该Skill

Quality Gate

质量把关

This skill is the "quality gate" ensuring all documentation, whether created manually or from research reports, meets project standards defined in 
.claude/rules/documentation/
.
该Skill是文档的“质量把关人”，可确保所有文档（无论是手动编写还是从研究报告生成的）都符合
.claude/rules/documentation/
中定义的项目标准。