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

### 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