Technical Documentation Standards
概要
IEEE 830、Documentation as Code、DRY原則に基づく技術文書化標準の専門スキル。
詳細な手順や背景は resources/Level1_basics.md と resources/Level2_intermediate.md を参照してください。
ワークフロー
Phase 1: 目的と前提の整理
目的: タスクの目的と前提条件を明確にする
アクション:
resources/Level1_basics.md と resources/Level2_intermediate.md を確認
- 必要な resources/scripts/templates を特定
Phase 2: スキル適用
目的: スキルの指針に従って具体的な作業を進める
アクション:
- 関連リソースやテンプレートを参照しながら作業を実施
- 重要な判断点をメモとして残す
Phase 3: 検証と記録
目的: 成果物の検証と実行記録の保存
アクション:
scripts/validate-skill.mjs でスキル構造を確認
- 成果物が目的に合致するか確認
scripts/log_usage.mjs を実行して記録を残す
ベストプラクティス
すべきこと
- resources/Level1_basics.md を参照し、適用範囲を明確にする
- resources/Level2_intermediate.md を参照し、実務手順を整理する
避けるべきこと
- アンチパターンや注意点を確認せずに進めることを避ける
コマンドリファレンス
リソース読み取り
cat .claude/skills/technical-documentation-standards/resources/Level1_basics.md
cat .claude/skills/technical-documentation-standards/resources/Level2_intermediate.md
cat .claude/skills/technical-documentation-standards/resources/Level3_advanced.md
cat .claude/skills/technical-documentation-standards/resources/Level4_expert.md
cat .claude/skills/technical-documentation-standards/resources/clarity-checklist.md
cat .claude/skills/technical-documentation-standards/resources/doc-as-code.md
cat .claude/skills/technical-documentation-standards/resources/dry-for-documentation.md
cat .claude/skills/technical-documentation-standards/resources/ieee-830-overview.md
cat .claude/skills/technical-documentation-standards/resources/legacy-skill.md
cat .claude/skills/technical-documentation-standards/resources/verification-patterns.md
スクリプト実行
node .claude/skills/technical-documentation-standards/scripts/check-dry-violations.mjs --help
node .claude/skills/technical-documentation-standards/scripts/log_usage.mjs --help
node .claude/skills/technical-documentation-standards/scripts/validate-skill.mjs --help
テンプレート参照
cat .claude/skills/technical-documentation-standards/templates/srs-template.md
変更履歴
| Version | Date | Changes |
|---|
| 1.0.0 | 2025-12-24 | Spec alignment and required artifacts added |