documentation
技術ドキュメントの作成・維持管理を行います。「〇〇のドキュメントを書いて」「READMEを作成して」「ランブックを書いて」「オンボーディングガイドが必要」などのリクエスト、またはAPI仕様書・アーキテクチャ設計書・運用手順書などあらゆる技術的な文書作成が必要な場面でトリガーされます。
description の原文を見る
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
SKILL.md 本文
技術ドキュメント
異なるオーディエンスと目的に対して、明確で保守性の高い技術ドキュメントを作成します。
ドキュメントの種類
README
- これが何であり、なぜ存在するのか
- クイックスタート(最初の成功まで 5 分未満)
- 設定と使い方
- 貢献ガイド
API ドキュメント
- リクエスト/レスポンスの例付きエンドポイント リファレンス
- 認証とエラーコード
- レート制限とペジネーション
- SDK の例
Runbook
- この Runbook をいつ使用するか
- 前提条件とアクセスに必要なもの
- ステップバイステップの手順
- ロールバック手順
- エスカレーション パス
アーキテクチャ ドキュメント
- コンテキストと目標
- 図を含む高レベルの設計
- 主要な決定とトレードオフ
- データフローと統合ポイント
オンボーディング ガイド
- 環境セットアップ
- 主要システムとそれらの接続方法
- ウォークスルー付きの一般的なタスク
- 何について誰に聞くか
原則
- 読者のために書く — 誰がこれを読んでいるのか、何が必要か?
- 最も有用な情報から始める — 重要な情報を埋もれさせないこと
- 説明ではなく実例を示す — コード例、コマンド、スクリーンショット
- 現在の状態を保つ — 古いドキュメントは存在しないドキュメントより悪い
- リンクを張る、複製しない — コピーの代わりに他のドキュメントを参照する
ライセンス: Apache-2.0(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- anthropics
- ライセンス
- Apache-2.0
- 最終更新
- 不明
Source: https://github.com/anthropics/knowledge-work-plugins / ライセンス: Apache-2.0
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理(非同期ジェネレータを含む)、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。