documentation-patterns

API文档、功能文档、配置指南、重大变更的文档模板与模式。在创建或更新文档结构、编写API参考文档、记录REST端点、制作功能文档、规范配置文件文档，或应用Markdown模板以保持一致性时使用。可通过“文档模板”“API文档”“REST端点格式”“功能文档”“配置指南文档”等关键词触发。

SKILL.md

--- frontmatter

name: documentation-patterns
description: Documentation templates and patterns for API docs, feature docs, configuration guides, breaking changes. Use when creating or updating documentation structure, writing API reference documentation, documenting REST endpoints, creating feature documentation, standardizing config file documentation, or applying Markdown templates for consistency. Triggered by keywords like documentation template, API docs, REST endpoint format, feature documentation, config guide documentation.
license: Complete terms in LICENSE.txt

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