Skip to content
Apothem
パイプラインコマンド

/docs-review

/docs-review——散文規約と十次元品質基準に照らしたドキュメントレビューパス。

役割: ドキュメントレビュアー パイプライン位置: フォートレス

散文規約と十次元品質基準に照らしたドキュメントレビューパス。

正規の呼び出し

/docs-review

引数付き:

/docs-review [path/to/repo/ or path/to/docs-source/] [--focus FILE_OR_DIR] [--dry-run]

入力

ホストリポジトリのドキュメント面

出力

ドキュメントの所見(_inputs/docs-review-findings.md)

下流

監査レビューシーケンスのドキュメントレビューステージ

ワークフローのフェーズ

このコマンドは 5 つのフェーズを実行します。入力の取り込み、ページごとの走査、所見ごとのトリアージ、所見の出力、そして検証ゲートです。

失敗モード

症状原因復旧
品質ゲート FAIL出力が基準を満たさない出力を修正して再実行する
入力ファイルが欠落指定したパスで文書ファイルに到達できないMarkdown ページを含むリポジトリルートまたはドキュメントのソースディレクトリを渡す

例

# Dry-run to preview what would happen
/docs-review --dry-run

# Execute against a repository root
/docs-review path/to/repo/

相互参照

On this page