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
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
功能与用途
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
快速开始
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
使用指南 ↗使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-02-10
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!