Skip to content

feat: 独立チェックリスト集と図表索引を追加する #240

Description

@ootakazuhiko

位置付け

PortalのProfile B必須module監査で、章内に点在するチェック項目とMermaidコードは存在するが、独立したchecklist packと公開図表索引が未実装であることを確認した。既存目次やコード例を代用せず、reader-facingな専用実体と導線を追加する。

正本・公開契約

  • GitHub PagesとQAの公開正本: docs/**
  • src/**はlegacy build inputであり、公開正本と安全に同期できる変更だけを同期する
  • checklist pack canonical route: /appendices/checklist-pack/
  • figure index canonical route: /appendices/figure-index/

実装範囲: checklist pack

  • docs/appendices/checklist-pack/index.mdへ、章内の実運用チェック項目を目的別に再編した独立チェックリスト集を追加する
  • 少なくとも準備、Issue/計画、branch/commit、Pull Request/review、CI/CD、security、organization/large-scale operationの観点を含める
  • 各チェックリストから根拠となる章・付録へリンクし、コードブロック中の例示を実施済みチェック項目として誤認しない
  • examples/ai-agent-starter/security-checklist.mdexamples/self-hosted-runner-ops-checklist/README.mdは、公開対象・文脈を確認した上で関連資料として扱う

実装範囲: figures / figure index

  • 現在の公開本文にある次の5つのMermaid図を、JavaScript非依存で表示できるアクセシブルな自己完結SVGへ変換する
    • 第1章: local → staging → local repository → remote repository
    • 第5章: public / private repositoryの判断
    • 第7章: hybrid review flow
    • 第9章: organization / team / repositoryの継承
    • 第12章: ML Git Flow
  • 各掲載箇所を<figure id="...">、代替説明、caption、stable anchorを持つ公開図版へ置換する
  • docs/appendices/figure-index/index.mdへ上記5件をexact inventoryとして掲載し、各章のstable anchorへdeep linkする
  • スクリーンショット用コード例、badge、favicon、logoは図表索引へ含めない
  • SVGの文字、矢印、コントラスト、狭幅表示を目視確認する

navigation / contract

  • checklist packとfigure indexを付録Gの後、あとがきの前に常設navigationとして追加する
  • 公開トップまたは常設navigationから各routeへ到達可能にする
  • book-config.jsonを公開実体と整合させ、ux.modules.checklistPack=trueux.modules.figureIndex=trueとする
  • canonical routes、navigation、5件の図版exact inventory、stable anchors、UX flagsを検証する回帰契約を追加する

非スコープ

  • #235のnpm allowScripts / Faraday warning対応を混在させない
  • 既存E2Eや欠落build script等の別債務を無関係に修正しない
  • npm run build:generate等で公開正本docs/**を意図せず巻き戻さない
  • _site/node_modules/等の生成物をcommitしない

検証

  • node scripts/validate_links.js(実在する同等script名の場合はその正本command)
  • npm ci
  • npm run lint:light
  • npm run test:light
  • npm run build
  • git diff --check
  • ローカルbuildで2 routes、navigation、5 deep links/anchors、SVG表示を確認する

完了条件

  • 独立checklist packと、5件の公開図版を列挙するfigure indexが公開される
  • 一般目次・章末チェック・コードブロックをmoduleの代用にしない
  • UX flagsと公開実体が一致する
  • PRレビュー本文・インライン・suggestionを全件確認し、review completeness status=ok / unresolved thread 0
  • CI green後にmainへmergeする
  • GitHub Pagesの2 canonical routes、navigation、5 deep linksを本番確認する
  • 本Issueとportal親Issue #227へPR・merge SHA・CI・Pages証跡を記録する

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions