mcpField
A
add-documentation

add-documentation

github.com/cowork-os開発51450 回インストール今日更新
リポジトリ

add-documentation について

関数にJSDocやdocstringを追加し、APIレベルのコメントを記述するスキルです。動作を維持してコード内ドキュメントを更新し、翻訳や変更履歴の作成には使用しません。

主な機能

  1. 01JSDocとdocstringの生成
  2. 02APIレベルのコメント追加
  3. 03コード動作の維持
  4. 04ドキュメント形式の選択

活用シーン

  1. 01コードファイル内の関数への文書追加
  2. 02API実装へのコメント追加

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/cowork-os/cowork-os --skill add-documentation

インストール後、Claude Code で/add-documentationを入力して読み込まれたか確認します。

詳細

ドキュメントを追加する

目的

関数の JSDoc/docstring を生成します

ルーティング

  • 使用する場合:コード内のドキュメント、docstring の追加、または API レベルのコメントをユーザーが求めた場合に使用します。
  • 使用しない場合:コンテンツの翻訳や、物語形式の変更履歴には使用しないでください。
  • 出力:インラインドキュメントを改善したコード成果物を更新します。
  • 成功基準:動作を維持しながら、ドキュメントの明確さと一貫性を高めます。

トリガーの例

肯定的な例
  • このリクエストには add-documentation スキルを使用してください。
  • ドキュメントの追加を手伝ってください。
  • コード内のドキュメント、docstring の追加、または API レベルのコメントをユーザーが求めた場合に使用します。
  • ドキュメントを追加:実行可能な成果を提供してください。
否定的な例
  • コンテンツの翻訳や、物語形式の変更履歴には使用しないでください。
  • 無関係なリクエストに add-documentation を使用しないでください。
  • このリクエストはドキュメント追加の対象外です。
  • これは概念的な議論のみを目的としており、ツールのワークフローは必要ありません。

パラメーター

名前型必須説明
pathstringはいドキュメントを追加するファイルのパス
styleselectはいドキュメントのスタイル

ランタイムプロンプト

  • 現在のランタイムプロンプトの長さ:523 文字。
  • ランタイムプロンプトは ../add-documentation.json で直接定義されています。

コメント