Documentation Patterns

This skill provides standardized templates and patterns for creating developer documentation.

Skill Paths

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

Activation Conditions

Use these patterns when:

• Creating new API documentation
• Documenting REST endpoints or HTTP methods
• Writing feature documentation
• Standardizing configuration documentation
• Applying consistent Markdown formatting
• Creating migration or breaking change guides

Documentation Templates

See API Documentation Templates for standard API endpoint, function, and method documentation formats.

See Feature Documentation Templates for feature descriptions, usage examples, and troubleshooting sections.

See Configuration Documentation Templates for environment variable, config file, and deployment documentation.

Best Practices

• Use consistent heading hierarchy
• Include working code examples
• Document edge cases and limitations
• Provide clear, concise descriptions
• Use accurate type information for parameters