AgentSkillsCN

documentation

依据 Labee 标准编写并审核文档。在创建或审阅 Markdown 文件时使用此方法。触发条件包括“文档”、“README”、“Markdown”、“docs”、“文档撰写”、“文档审核”。

SKILL.md
--- frontmatter
name: documentation
description: Write and review documentation following Labee standards. Use this when creating or reviewing markdown files. Triggers on "ドキュメント", "README", "markdown", "docs", "文書作成", "ドキュメントレビュー".
model: haiku
context: fork
allowed-tools: Read, Glob, Grep

Documentation Skill

Write and review documentation following Labee standards.

Core Principles

  1. •Clarity over completeness - Write what is necessary, no more
  2. •Consistent structure - Follow established patterns
  3. •Actionable content - Every document should help readers accomplish something

When Invoked

Step 1: Identify Task Type

  • •Writing new docs? → Go to Step 2a
  • •Reviewing existing? → Go to Step 2b
  • •Formatting questions? → Load markdown-formatting.md directly

Step 2a: Writing New Documentation

  1. •Load references/content-types.md to choose document type
  2. •Load references/document-structure.md for structure template
  3. •Apply writing principles from _core-rules.md (auto-loaded)
  4. •Draft document following templates

Step 2b: Reviewing Documentation

  1. •_core-rules.md is auto-loaded with P1 rules
  2. •Check against rules, noting specific issues with line numbers
  3. •Categorize issues by priority (P1 must fix, P2 should fix, P3 nice to have)

Step 3: Provide Output

For writing: Provide draft following templates For review: List specific issues with:

  • •Line number
  • •Issue description
  • •Suggested fix

Reference Files

FileUse When
references/_core-rules.mdAuto-loaded: Essential P1 rules for all documentation
references/writing-principles.mdVoice, tone, grammar, inclusive language
references/document-structure.mdStructuring documents
references/markdown-formatting.mdMarkdown syntax questions
references/file-organization.mdOrganizing files/folders
references/content-types.mdChoosing document types
references/code-examples.mdIncluding code in docs
references/ai-documentation.mdWriting AI context files
references/project-structure.mdProject documentation
references/culture-principles.mdCompany values/culture