mcpField
D
documentation-patterns

documentation-patterns

github.com/thalysjuvenal開発19351 回インストール7 週間前に更新
リポジトリ

documentation-patterns について

documentation-patternsは、ADVPL/TLPPソースからProtheus標準の技術文書を生成するスキルです。関数ヘッダー、ルーチン仕様書、RESTエンドポイント文書のテンプレートを備え、コードと利用可能なgit履歴から情報を抽出します。

主な機能

  1. 01関数・メソッドヘッダーのテンプレート
  2. 02ルーチン仕様書のテンプレート
  3. 03RESTエンドポイント文書のテンプレート
  4. 04コード情報と依存関係の抽出
  5. 05利用可能なgit履歴の活用

活用シーン

  1. 01コードへのProtheus.docヘッダー追加
  2. 02ルーチンの動作と依存関係の文書化
  3. 03RESTエンドポイント文書の作成

インストール

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

$npx skills add https://github.com/thalysjuvenal/advpl-specialist --skill documentation-patterns

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

同梱ファイルreference.md

詳細

ADVPL/TLPP ドキュメント作成パターン

このスキルでは、ADVPL/TLPP のソースコードを Protheus 標準の技術ドキュメントに変換するためのテンプレートと生成プロセスを提供します。対象となる出力形式は 3 種類です。単一の関数／メソッド向けの header Protheus.doc コメントブロック、目的、モジュール、読み書きするテーブル、MV_* パラメーター、エントリーポイント、実行フロー、依存関係、変更履歴を含む full Markdown ルーチン仕様書、および認証、パス／クエリパラメーター、リクエストボディ、レスポンススキーマを含む api REST エンドポイントドキュメントです。

ユーザーが既存のコードに対して、TOTVS の規約に沿ったドキュメント（ヘッダー、ルーチン仕様書全体、または API ドキュメント）の生成や追加を依頼した場合に、このスキルを有効にしてください。このプロセスでは対象ファイルを読み込み、コード自体から関数、パラメーター、テーブル、MV_* の使用状況、エントリーポイント、依存関係を抽出します。利用可能な場合は、Git の履歴を確認して作成者と変更履歴を照合した後、適切なテンプレートに記入します。

このスキルは、対象者向けにコードを会話形式の平易な言葉で説明すること（code-explanation を参照）、ドキュメントの正確な記述に必要なネイティブ関数のシグネチャを調べること（protheus-reference を参照）、またはルーチン内で使用されている埋め込み SQL マクロの意味をドキュメント化すること（embedded-sql を参照）は対象としていません。

参照ファイル読み込むタイミング
reference.md常に。3 種類のドキュメント形式（header/full/api）のテンプレートと生成プロセスを記載しています。

コメント

Markdown 対応