AgentSkillsCN

documentation-quality

文档质量标准、格式化指南与写作原则。在撰写文档、确立文档质量标准、审查文档质量、制定写作指南，或设定文档指标时使用。可通过“文档质量”“写作指南”“文档标准”“格式化规则”“文档审查原则”等关键词触发。

SKILL.md
--- frontmatter
name: documentation-quality
description: Documentation quality standards, formatting guidelines, and writing principles. Use when writing documentation, establishing docs quality standards, reviewing doc quality, creating writing guidelines, or setting documentation metrics. Triggered by keywords like documentation quality, writing guidelines, doc standards, formatting rules, documentation review principles.
license: Complete terms in LICENSE.txt

Documentation Quality Standards

Skill Paths

  • •Workspace skills: .github/skills/
  • •Global skills: C:/Users/LOQ/.agents/skills/

Activation Conditions

Use this skill when:

  • •Writing new documentation
  • •Reviewing documentation for quality
  • •Establishing documentation standards
  • •Creating style guides for docs
  • •Checking documentation formatting

Writing Guidelines

See Writing Standards for:

  • •Clear, concise language principles
  • •Code example formatting
  • •Consistent terminology usage
  • •Error handling documentation
  • •Edge case documentation

Code Example Format

markdown
### Example: [Clear description of what example demonstrates]

\`\`\`language
// Include necessary imports/setup
import { function } from 'package';

// Complete, runnable example
const result = function(parameter);
console.log(result);
\`\`\`

**Output:**
\`\`\`
expected output
\`\`\`

Quality Checklist

  • • Language is clear and concise
  • • Code examples are complete and runnable
  • • Both basic and advanced examples included
  • • Terminology is consistent
  • • Error handling documented
  • • Edge cases and limitations covered