command-documentation-patterns
コマンドのドキュメント設計(セルフドキュメンティング構造/使用例/トラブルシューティング)を整理し、説明の一貫性と読みやすさを支援するスキル。 章構成、記述ルール、検証手順を一貫して整理する。 Anchors: • Software Requirements (Karl Wiegers) / 適用: 要求の言語化と構造化 / 目的: 説明品質の安定化 Trigger: Use when documenting commands, creating usage examples, or designing troubleshooting sections for command workflows. command documentation, usage examples, troubleshooting, self-documenting structure
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
コマンドのドキュメント設計(セルフドキュメンティング構造/使用例/トラブルシューティング)を整理し、説明の一貫性と読みやすさを支援するスキル。 章構成、記述ルール、検証手順を一貫して整理する。 Anchors: • Software Requirements (Karl Wiegers) / 適用: 要求の言語化と構造化 / 目的: 説明品質の安定化 Trigger: Use when documenting commands, creating usage examples, or designing troubleshooting sections for command workflows. command documentation, usage examples, troubleshooting, self-documenting structure
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!