Skip to content

docs: 大会運営・開発の画面付きHTML手順書を追加 - #3

Merged
polyacetal merged 6 commits into
developfrom
codex/html-user-manuals
Sep 23, 2026
Merged

polyacetal merged 6 commits into
developfrom
codex/html-user-manuals

Conversation

@polyacetal

@polyacetal polyacetal commented Sep 23, 2026 •

Copy link
Copy Markdown

変更内容

当日の運営操作と開発・復旧の手順が複数の設計資料に分散していたため、実画面・図・表を使ったHTML手順書を2部構成で追加します。

  • 第1部「大会運営」:大会設定、参加者・予選、先後交代の2戦記録、勝因、訂正・再試合、本戦作成、掲示、終了後の保存、困ったときの早見表。
  • 第2部「開発」:初回起動、処理の構成、変更と検証、会場向け起動、保存・復旧、不具合調査、手順書の更新。
  • 11枚の実画面はBase64のデータURLとしてHTML内に埋め込みます。PNG・JPEG・WebP・PDF等のバイナリファイルは追加していません。図は差分を確認できるテキスト形式のSVGです。
  • 目次、画像の拡大/原寸表示、スマートフォン表示、A4印刷とページ番号、オフライン閲覧に対応します。外部フォント・ライブラリーは不要です。
  • 画像の識別名を指定して更新するツールを用意し、HTML・CSS・JSを既存の整形検査へ追加します。

手順書の入口は chros/public/manual/index.html です。アプリ起動中は /manual/index.html を開きます。サーバーなしで読む場合は、manual フォルダー全体を保存して index.html をブラウザーで開きます。GitHubのファイル画面はHTMLソースの表示になるため、閲覧方法をREADMEにも記載しています。

レビューの順序

マージ後のdevelop(f00a3f2)から codex/html-user-manuals を作成しました。

コミット 確認点
5975c7f 画像更新ツール 画像形式・識別名の検証、対象のsrcだけをBase64で更新する処理
3721dc7 HTML手順書 2部の手順・実画面と説明の一致・図表・表示と印刷
48f5c76 案内と開発基準 資料への導線、作成時の判断、整形検査、旧DB必須記述と旧ファイル参照の修正

Base64部分は画像を表示して確認し、前後の代替テキスト・図の説明・手順をレビューしてください。撮影は本番データと別の保存先で行い、すべて架空の参加者を使用しています。

検証

  • GitHub Actionsで整形・型・29件のテストが成功
  • Next.js本番ビルド成功、本番サーバーから3つのHTMLを配信
  • 1440px・390px幅で3ページを確認し、ページ全体の横はみ出しなし
  • 11枚の埋め込み画像、内部リンク・目次・資料間移動、画像の拡大・原寸表示・Escでの終了を確認
  • 通信を止め、JavaScriptを無効にしてHTMLを直接開いても本文・図・画像を閲覧可能
  • A4印刷を全ページ画像化し、図表・改ページ・ページ番号を確認(確認用のPDF・PNGはリポジトリ外)
  • 画像更新ツールの正常更新、不明な識別名・不正画像で更新しないこと、他のHTMLを維持することを確認
  • Prettier、差分の空白検査、全追加資料がUTF-8テキストであることを確認

判断と範囲

作成時の判断と更新方法は docs/manuals.md に記載しています。採点・保存・運営画面のアプリ実装は変更していません。釧路向けの計算や配置は現在の試作の判断として説明し、公式規則との確認箇所を明記しました。GitHub Pagesの公開設定とDocker実機検証は含めていません。

画像の識別名を指定してBase64データURLを更新する。画像ファイルの形式と対象タグを検証し、PNGやJPEGをGitに追加せず差し替えられるようにする。
2部の入口、実操作に沿った手順、図表、11枚のBase64スクリーンショットを用意。オフライン閲覧、画像の原寸表示、スマートフォン表示、印刷に対応する。
HTML手順書への案内と作成時の判断を記録し、整形対象へ追加する。既存WebApp READMEのDB必須記述と、技術要件の旧ファイル参照を現在の構成に合わせる。

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

不自然な改行があります
Image

見出し用スタイルを注意書き直下のstrong要素に限定し、本文中の「1戦」が独立した行になる問題を修正する。警告色の指定も同じ範囲にそろえる。

確認: 両手順書を1440px・390pxで表示し、見出しと本文のレイアウトを確認。Prettierとgit diff --checkが成功。
操作説明の文体と句点を統一し、長いコマンドを内容を変えずに分割する。練習例の目的を明示し、図の遅延読み込みを外して全ページ撮影時の欠落を防ぐ。

確認: 1440px・390pxの描画、全画像の初期読込、画像内容とコマンド内容の維持、zsh構文検査、A4印刷、整形検査。
初回14件の指摘、採用・見送りの理由、抽出と撮影の制約、ローカル検証を保存する。API 429で修正後の再レビューが未完了であることも明記する。画像・PDFやAPIキーは含めない。

@arumino-om arumino-om left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@polyacetal
polyacetal merged commit 7928674 into develop Sep 23, 2026
1 check passed
@polyacetal
polyacetal deleted the codex/html-user-manuals branch September 23, 2026 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants