Skip to content

docs: 45th の運用で踏んだことのうち、手順書にないものを足す - #574

Merged
taminororo merged 4 commits into
developfrom
docs/kanba/573/ops-lessons-to-docs
Oct 1, 2026
Merged

taminororo merged 4 commits into
developfrom
docs/kanba/573/ops-lessons-to-docs

Conversation

@taminororo

@taminororo taminororo commented Sep 30, 2026 •

Copy link
Copy Markdown
Collaborator

対応Issue

resolve #573

概要

45th の運用で踏んだことのうち、PM の作業メモにしか残っていなかったものを、手順書に足しました。

文書 足したこと 元になった出来事
docs/development/onboarding.md 11節 mobile のテストは CI で走らないので、手元で回す #492 のテストが、#510 の文言の変更と食い違ったまま develop に入った(#516 で直した)
〃 dart fix で直せるかは、analyze と dart fix --dry-run の件数を比べて決める #288 を「自動で直せる」と分類して割り振ったが、dart fix が何も直せなかった(#286 を4分類に直した)
docs/operations/day-of-support.md psql は keepalives を付けて接続する 放置した接続が切れていて、BEGIN が飲み込まれた(既存の項の前提)
〃 tasks の行を消す前に、外部キーの参照とコードの id の直書きを両方確かめる 「タスク外」(id=3)は参照0件だが、mobile のトラブルの報告が数字の 3 で送っている
docs/operations/seeft-data-contract.md シートと DB を突き合わせるときは、NG も数えてタスクごとに比べる セルの値だけ数えて「古い割り当てが残っている」と読み違えた
docs/development/manual-html-operations.md 承認済みのマニュアルを一部だけ直すときは、再生成せず差し替える 再生成すると LLM の揺れで確認をやり直すことになる
〃 正しい版は、更新日時ではなく依頼と承認の履歴で決める 更新日時が新しい版を上げたら、構造が崩れていた

チームの約束事と手順なので、ADR にはしていません(docs/decisions/README.md の「何を ADR にするか」、PR #570 で入る予定の基準)。

画面スクリーンショット等

なし(ドキュメントのみ)

テスト項目

確かめたこと

  • CI の workflow(flutter-lint.yml・go-test.yml)が PR のときだけ走り、mobile では flutter analyze だけであること
  • tasks を参照している表が4つであること(postgresql/db/schema/ の REFERENCES tasks)と、trouble.dart がタスク外を 3 で送っていること
  • --embed-only が埋め込み済みの data: を飛ばすこと(scripts/claude-slide/generate_slide.py#_resolve_image_src)

見てほしいこと

  • 書いた手順が、当時のやり方と合っているか

備考

  • 公開リポジトリなので、接続先や個人名は書いていません
  • 2つ目と3つ目のコミットで、公開の文書から委員会の中の識別子を消しました。公開の文書に書かない方針(PR docs: 開発の進め方の文書を足し、ADR をシステムと運用の判断に絞る #570 の workflow.md 2節)に合わせるためです。git の履歴には残ります
    • manual-html-operations.md:Slack のチャンネル名と ID、シフトスプシとマニュアル割り当てのスプシの ID(2か所)。ID は後任に渡す非公開の別紙にあることを確かめ、文書には「別紙にある」と書いた
    • docs/proposals/manual-proposal-v4-slides/automation-design.md:ステータス管理スプシの ID を <ステータス管理スプシの ID> に置き換えた
    • gas/ のコードにも同じスプシの ID が直書きされていますが、直書きしてよいかは PM の判断待ちなので、この PR では触っていません

Summary by CodeRabbit

  • ドキュメント
    • 承認済みマニュアルの一部を公開中のHTMLに直接反映する手順と、再生成が必要な場合の判断基準を追記しました。
    • モバイル向けのCIで実行されないテストや、解析結果を確認する方法を明記しました。
    • データベースの確認時やシフト送信後の件数照合に関する注意点を追加しました。
    • スプレッドシートIDの設定例をプレースホルダーに変更し、具体的なIDの記載を取り除きました。

mobile のテストが CI で走らないこと、dart fix で直せるかの確かめ方(onboarding.md)、psql の keepalives と tasks を消す前の確認(day-of-support.md)、シートと DB の突き合わせ方(seeft-data-contract.md)、承認済みマニュアルの部分修正と正しい版の決め方(manual-html-operations.md)を足した。
@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: NUTFes/SeeFT/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: a04cd6bf-7082-4cde-9d39-2738e085fc1e

📥 Commits

Reviewing files that changed from the base of the PR and between 8f960f3 and 1f4de05.

📒 Files selected for processing (5)
  • docs/development/manual-html-operations.md
  • docs/development/onboarding.md
  • docs/operations/day-of-support.md
  • docs/operations/seeft-data-contract.md
  • docs/proposals/manual-proposal-v4-slides/automation-design.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

開発・運用の手順書を更新しました。承認済みマニュアルの部分更新、mobile開発時の確認、DB調査、シフト送信後の件数照合に関する手順を追加または変更しました。

Changes

開発・運用手順書

Layer / File(s) Summary
承認済みマニュアルの更新手順
docs/development/manual-html-operations.md, docs/proposals/manual-proposal-v4-slides/automation-design.md
HTML内の表や図を部分更新する手順と、依頼・承認履歴に基づいて版を選ぶ方法を追加しました。スプレッドシートIDやSlack情報の記載を変更し、設定例のIDをプレースホルダーにしました。
mobile開発時の確認手順
docs/development/onboarding.md
mobileの変更時は手元でflutter testを実行することと、flutter analyzeとdart fix --dry-runの結果をルールごとに比較する手順を記載しました。
DB調査とtasks削除前の確認
docs/operations/day-of-support.md
接続URLのkeepalive設定と、tasksの行を削除する前に参照先の件数およびコード内のID利用箇所を確認する手順を記載しました。
シフト送信後の件数照合
docs/operations/seeft-data-contract.md
参加不可セルも数え、総数ではなくタスクごとにシートとDBの件数を比較する注意を記載しました。

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 1f4de

The updated procedures retain the transaction checks and cover the relevant rescue records before task deletion. No concrete issue remains that should block merging.

Architecture Summary

Architecture risk: 🔵 Low · up to 1f4de

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 5 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/development/manual-html-operations.md: 承認済みマニュアルは再生成せず、HTML内で旧 source.html 由来の表行を照合して新しい行に置換し、図は埋め込み画像のbase64文字列を差し替える手順を追加した。--embed-only は既埋め込み画像を飛ばすため差し替えには使えず、表の構成や役割まで変わる場合は再生成する。また、正しい版を更新日時で判断せず、窓口チャンネルの依頼・承認履歴で決め、未反映依頼があれば元ドキュメントから作り直す手順を追加した。
  • observed — Modified behavior in docs/development/manual-html-operations.md: 割り当てスプレッドシートのIDを説明から削除し、命名規則の違いにより対応表キーをタスク一覧M列に揃える説明は維持した。
  • observed — Modified behavior in docs/development/manual-html-operations.md: スプレッドシートのIDを本文から削除し、後任向けの非公開資料に記載する方針に変更した。Slackチャンネル名・IDの一覧も削除し、関連する2つのスプレッドシート名のみを記載する。
  • observed — Modified behavior in docs/development/onboarding.md: mobile の CI 説明に、flutter test は実行されず、変更時には手元でテストを実行することと、テストとボタン文言の不一致が別々の PR を経て混入した事例を追記しています。
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed タイトルは、45th の運用で得た未記載の手順を文書へ追加するという主な変更を具体的に示しています。簡潔で、変更内容と整合しています。
Description check ✅ Passed 対応Issue、概要、画面変更の有無、テスト項目、備考を記載しています。変更対象と確認内容も具体的で、テンプレートの主要項目を満たしています。
Linked Issues check ✅ Passed #573 の要求を満たしています。onboarding.md は mobile の手元での flutter test と、flutter analyze / dart fix --dry-run の件数比較を追加しています。day-of-support.md は keepalives、外部キー参照、コード内の ID 直書きの確認を追加しています。`seeft-data-co…
Out of Scope Changes check ✅ Passed 変更対象は #573 が指定する4つの手順書と、同 issue が指定する docs/proposals/manual-proposal-v4-slides/automation-design.md です。運用手順の補足、識別子の除去、設定値の外部化は要求の実装に直接関係します。無関係な変更は確認できません。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

manual-html-operations.md のシフトスプシとマニュアル割り当ての ID(ID は非公開の別紙にある)と、docs/proposals の自動化設計にあったステータス管理スプシの ID を消した。
# Conflicts:
#	docs/development/onboarding.md
@taminororo

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@taminororo
taminororo merged commit 5048287 into develop Oct 1, 2026
2 checks passed
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.

docs: 45th の運用で踏んだことのうち、手順書にないものを足す

1 participant