コンテンツにスキップ
pentaglyph

プロファイルリファレンス

このページの内容: 各 --profile がインストールするセクションの正確なリストで、CLI ソース（cli/src/lib/profiles.ts）から導出されているので常に正確です。 どのプロファイルを選ぶか の判断は how-to/adopt-existing-project.md を参照。

Terminal window
pentaglyph init <target> --profile=<minimal|standard|full>

--profile を省略すると default は standard。

プロファイルに関係なく常にインストールされるもの

Section titled “プロファイルに関係なく常にインストールされるもの”

以下のセクションは無条件 ―― 全プロファイルがインストールします。

セクションパス目的
Root filesdocs/INDEX.md, docs/STRATEGY.md, docs/WORKFLOW.md, docs/AI_INSTRUCTIONS.md4 つのエントリポイントファイル。これらなしではキットは機能しません
templatesdocs/templates/すべての執筆テンプレート（template-index.md 参照）

minimal — アーキテクチャ・スパインのみ

Section titled “minimal — アーキテクチャ・スパインのみ”
docs/
├── INDEX.md          STRATEGY.md          WORKFLOW.md          AI_INSTRUCTIONS.md
├── templates/        ← 常時
└── arc42/            ← §1–§12 stubs + 09-decisions/ (MADR ADRs)

使うとき:

  • プロジェクトがライブラリ・プロトタイプ・単一チーム内部ツール
  • 最軽量のスキャフォールドで始めたい
  • 既存コードベースに pentaglyph を導入する（how-to/adopt-existing-project.md 参照）

スキップされるもの: C4 図、detailed-design、api-contract、design-guide、Layer B 全部（impl-plans / task-list / postmortems / reports / cost-estimates）、user-manual。

standard — 推奨 default

Section titled “standard — 推奨 default”
docs/
├── INDEX.md          STRATEGY.md          WORKFLOW.md          AI_INSTRUCTIONS.md
├── templates/        ← 常時
├── arc42/            ← §1–§12
├── diagrams/         ← C4 Structurizr DSL
├── detailed-design/  ← モジュール別仕様
├── api-contract/     ← OpenAPI / GraphQL / MCP / RPC スキーマ
├── design-guide/     ← 運用規約
├── impl-plans/       ← 日付付き実装プラン (Layer B)
├── postmortems/      ← インシデント振り返り (Layer B)
└── reports/          ← 単発のリサーチ / 評価レポート (Layer B)

使うとき:

  • 複数モジュールを持つ通常のプロダクトチーム
  • public API / RPC / GraphQL エンドポイントを持ち契約 surface が必要
  • AI エージェントが定期的にコードを変更し、 code change → doc change ループを噛ませる必要がある

スキップされるもの: task-list/、cost-estimates/、user-manual/。

これが default プロファイル です。迷ったらこれ。

full — エンドユーザー向けプロダクト

Section titled “full — エンドユーザー向けプロダクト”
docs/                 ← standard の全部 +
├── …
├── task-list/        ← スプリント単位のタスク分解 (Layer B)
├── cost-estimates/   ← コスト見積もり (Layer B)
└── user-manual/      ← エンドユーザー docs の Diátaxis 4 象限
    ├── tutorials/
    ├── how-to/
    ├── reference/
    └── explanation/

使うとき:

  • 実ユーザー（内部 / 外部）に UI または API を出荷する
  • ペルソナ / ジャーニー駆動のエンドユーザー docs（Diátaxis）が必要
  • スプリントレベルの作業をリポ内で追跡（稀だが正当な team もある）

プロファイル別セクション一覧

Section titled “プロファイル別セクション一覧”
セクションminimalstandardfull
templates/✅✅✅
arc42/✅✅✅
diagrams/ (C4)—✅✅
detailed-design/—✅✅
api-contract/—✅✅
design-guide/—✅✅
impl-plans/—✅✅
postmortems/—✅✅
reports/—✅✅
task-list/——✅
cost-estimates/——✅
user-manual/——✅

4 つのエントリポイント root ファイル（INDEX.md、STRATEGY.md、WORKFLOW.md、AI_INSTRUCTIONS.md）は無条件にインストールされるので、上表からは省略しています。

--include での上書き

Section titled “--include での上書き”

プロファイルを無視して明示的なリストを指定するには --include を使います:

Terminal window
pentaglyph init ./my-app --include=arc42,detailed-design,api-contract --ai=claude

--include は、列挙したものに加えて無条件 root ファイルと templates/ を常にインストールします。

--include に何度も手を伸ばしているなら、本当の意図は別のプロファイルである可能性大です。

あとから昇格

Section titled “あとから昇格”

セクション追加に re-init は不要。pentaglyph add <section> は冪等で、名指したディレクトリだけを書きます:

Terminal window
pentaglyph add user-manual ./my-app
pentaglyph add task-list   ./my-app
pentaglyph add cost-estimates ./my-app

add を 4 回以上呼んだなら、実質次のプロファイル相当に到達しています。新参が同じレベルから始められるよう、チームハンドブックに反映しましょう。

既知の注意事項

Section titled “既知の注意事項”
  1. service-design、governance、metrics はどのプリセットプロファイルにも含まれません。 template/docs/ 配下に存在し --include 値として有効ですが、default ではどのプロファイル（full 含む）もインストールしません。明示的に指定:
    Terminal window
    pentaglyph init ./my-app --profile=full --include=arc42,diagrams,detailed-design,api-contract,design-guide,impl-plans,task-list,postmortems,reports,cost-estimates,user-manual,service-design,governance,metrics
    # あるいは典型的には init 後に add:
    pentaglyph add service-design ./my-app
    pentaglyph add governance ./my-app
    pentaglyph add metrics ./my-app
    ほとんどのプロジェクトで不要なため opt-in ですが、導入チームは選択肢として存在することを知っておくべき
  2. --profile=enterprise や similar tier はありません。 規制プロセスのスキャフォールド（重い governance、SLSA attestations 等）のカスタムミックスは CLI のスコープ外。full の上に組み立て、結果をプロジェクト自身のリポジトリに check-in
  3. --ai=claude は .claude/rules/documentation.md 以上をインストール します。 .claude/ ツリー全体（agents + skills）も target に drop されます。詳細は ai-targets.md を参照

関連

Section titled “関連”