example-usage-patterns
Documentation patterns for creating clear, executable, and maintainable usage examples across APIs, CLIs, libraries, and frameworks. Anchors: • Docs for Developers (Jared Bhatti et al.) / 適用: 実践的な例示パターン / 目的: 開発者に即座に理解・実行可能な例を提供 • The Documentation System (Diataxis) / 適用: チュートリアル・ハウツー・リファレンス分類 / 目的: 目的に応じた例の種類と粒度を選択 • Clean Code (Robert C. Martin) / 適用: 明確な命名・単一責務 / 目的: 自己説明的なサンプルコード Trigger: Use when creating code examples, writing tutorials, documenting API usage, building sample projects, establishing example conventions, or standardizing example patterns across a codebase. example creation, tutorial writing, API documentation, sample code, documentation patterns
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Features and purpose
Documentation patterns for creating clear, executable, and maintainable usage examples across APIs, CLIs, libraries, and frameworks. Anchors: • Docs for Developers (Jared Bhatti et al.) / 適用: 実践的な例示パターン / 目的: 開発者に即座に理解・実行可能な例を提供 • The Documentation System (Diataxis) / 適用: チュートリアル・ハウツー・リファレンス分類 / 目的: 目的に応じた例の種類と粒度を選択 • Clean Code (Robert C. Martin) / 適用: 明確な命名・単一責務 / 目的: 自己説明的なサンプルコード Trigger: Use when creating code examples, writing tutorials, documenting API usage, building sample projects, establishing example conventions, or standardizing example patterns across a codebase. example creation, tutorial writing, API documentation, sample code, documentation patterns
Quick start
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
Guides ↗Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-02-10
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!