Docs: ai-plugins 紹介プレゼン資料を追加 - #61
Merged
Merged
Conversation
社内勉強会向けの15分・12枚のスライドを Marp 形式で追加した。NDF の概要は 説明済みという前提で、PR/レビューワークフローと設計・仕様ドキュメント系 スキルの個別機能紹介を中心に構成している。 - スライド本体は docs/presentations/2026-08-06-ai-plugins-intro.md - 図版は Mermaid ソースを diagrams/ に残し、PNG を images/ に生成 - 各スライドの HTML コメントに発表台本と時間配分を記載 - Codex CLI / Kiro CLI でのインストール手順も1枚で紹介 - ビルド手順は docs/presentations/README.md に記載 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wa3ZT8WCqEDTyybpZ6Zncw
配布・閲覧用に、スライドから書き出した PDF をリポジトリに含める。しおり付き (--pdf-outlines) で生成し、Markdown を編集したら再生成してコミットする運用を README に明記した。 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wa3ZT8WCqEDTyybpZ6Zncw
紹介の粒度を「何ができるか」から「何が書いてあり、何を重視しているか」へ 広げた。レビュー系は /ndf:review と /ndf:cross-review の2つに絞り、空いた 枠を各スキルの中身の説明に充てている。 - 各スキルを「書いてあること」「重視していること」の2軸で紹介 - /ndf:review はレビュー観点の優先順位と、重要度ラベルが後段の自動修正に 直結する仕組みを2枚に分けて説明 - /ndf:cross-review は変更ファイル種別に応じた観点テンプレート15分類を追加 - /ndf:investigation-rules と /ndf:problem-solving を1枚として追加 - /ndf:review-branch と指摘対応3段 (review-pr-comments / fix / resolve-pr-comments) の紹介は削除 - 流れの図をレビュー系2つに合わせて描き直し - 12枚 15分 → 15枚 15分。台本の時間配分を再割当 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wa3ZT8WCqEDTyybpZ6Zncw
Marp の HTML 出力は images/ を相対パスで参照し、絵文字を CDN 上の SVG に 置き換えるため、ファイル単体では画像が表示されず、オフラインでは絵文字も 欠ける。build.sh で画像を data URI へ埋め込み、絵文字を文字へ戻したうえで、 外部アセット参照が残っていないことを検証してから書き出す。 HTML はプレゼンタービュー (p キー) で台本と次スライドとタイマーを表示できる ため、発表本番はこちらを使う。PDF は配布用として引き続き同梱する。 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wa3ZT8WCqEDTyybpZ6Zncw
main の docs/ を GitHub Pages で配信し、スライドをブラウザから直接開ける ようにする。Jekyll は無効化し、ビルド前のファイルをそのまま配信する。 - docs/.nojekyll を追加(Jekyll による変換を止める) - docs/presentations/index.html を追加(資料一覧の入口) - README に公開 URL と、資料追加時に index.html も更新する運用を追記 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wa3ZT8WCqEDTyybpZ6Zncw
GitHub Pages は docs/ を配信するため、docs/index.html が無いとサイトの ルートが 404 になる。公開しているのはプレゼンテーション資料だけなので、 ルートから資料一覧へ転送する。 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Wa3ZT8WCqEDTyybpZ6Zncw
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
社内勉強会向けのスライド資料を
docs/presentations/に追加します。NDF の概要は説明済みという前提で、個別機能の紹介を中心に構成しました。構成
/ndf:implementation-plan— プランの雛形と、「なぜ」を残すという狙い/ndf:pr— 引数解釈と、ブランチ事故を止める仕組み/ndf:review— レビュー観点の優先順位と具体的なチェックポイント/ndf:review— 重要度ラベルが後段の自動修正に直結する仕組み/ndf:cross-review— 両AIが APPROVE するまでの収束ループ/ndf:cross-review— 変更ファイル種別に応じた観点テンプレート15分類/ndf:plan-to-spec— 標準章立てと、移動ではなく書き直すという方針/ndf:markdown-writing— 第三者可読性の7ルール/ndf:investigation-rulesと/ndf:problem-solving— エビデンス主義と上流修正レビュー系スキルは
/ndf:reviewと/ndf:cross-reviewの2つに絞りました。/ndf:review-branchと、指摘対応の3段(/ndf:review-pr-comments→/ndf:fix→/ndf:resolve-pr-comments)は扱っていません。ファイル構成
図版は Mermaid で書き、PNG に変換したものをスライドから参照します。Marp が Mermaid を直接描画しないためで、
.mmdソースはdiagrams/に残しています。書き出し済みの PDF と HTML を同梱しています。Markdown を編集したら
build.shで両方を再生成してコミットする運用を README に明記しました。HTML を単一ファイル化しているのは、Marp の HTML 出力が
images/を相対パスで参照し、絵文字を CDN 上の SVG に置き換えるためです。そのまま配ると画像が表示されず、オフラインでは絵文字も欠けます。build.shが画像を data URI として埋め込み、絵文字を文字へ戻したうえで、外部アセット参照が残っていないことを検証します。発表本番は HTML(
pキーでプレゼンタービュー、台本と次スライドとタイマーが出る)、配布は PDF、という使い分けです。GitHub Pages での公開
このリポジトリの GitHub Pages を有効化し、
mainのdocs/を配信するよう設定しました。マージすると以下で読めるようになります。https://devbasex.github.io/ai-plugins/presentations/
docs/.nojekyll— Jekyll による変換を止め、ファイルをそのまま配信するdocs/index.html— サイトのルートから資料一覧へ転送する(無いとルートが 404 になる)docs/presentations/index.html— 資料一覧。スライド・PDF・Markdown へのリンクと操作方法AGENTS.mdのドキュメント一覧にもdocs/presentations/の行を追加しています。Test plan
npx @marp-team/marp-cli@4 --pdf --allow-local-filesで PDF に書き出せるpython3 scripts/check-markdown-links.py --root .が pass(README からスライド・図版への相対リンク)bash scripts/validate-runtime-plugins.shが passsrc="http…"と<link href="http…">を検査)builtで完了することを確認mainに反映されるまでは 404)備考
記載バージョンは #60 のマージ後に合わせて v4.20.1 としています。
やらないこと
docs/配下の Markdown を Pages 上で HTML としてレンダリングすること(Jekyll を無効にしているため、ソースのまま配信される)