lg_toolkit_guide

05_release_checklist.md - 配布前・利用開始前チェックリスト

使い方

• 該当する項目にチェックを入れる。
• 非該当の場合は「N/A」と記録する。
• 未対応項目は末尾の記録欄に理由と対応予定を書く。

---

1. 共通チェック

• ツールの目的と対象利用者が明記されている。
• できること / できないことが明記されている。
• 利用者向け操作手順が用意されている。
• エラー時の対応方針が明記されている。
• バージョンと更新履歴が更新されている。

2. 閉域環境チェック

• 閉域または庁内ネットワークで単独動作する。
• インターネット接続なしで主要機能が動作する。
• 管理者権限を前提にしていない。
• 追加インストールなし、または必要条件が明記されている。

3. 外部依存チェック

• 外部APIを使用していない。
• 外部CDNを参照していない。
• クラウドサービス連携を前提にしていない。
• 外部ライブラリがある場合、同梱・ライセンス・バージョン固定が明記されている。

4. セキュリティ・個人情報チェック

• 個人情報の恒久保存を行わない設計になっている。
• ログに個人情報を出力していない。
• 外部送信が発生しない。
• 画面またはREADMEに注意文がある。
• 最終判断が利用者側であることを明記している。

5. ファイル処理チェック

• 元ファイルを上書きしない。
• 出力先が明示されている。
• 破壊的処理に確認手順がある。
• 必要に応じてバックアップ手順がある。
• 再実行時の挙動が説明されている。

6. UI/UXチェック

• 入力欄・実行ボタン・結果表示欄が分かれている。
• 成功時メッセージが分かりやすい。
• エラー時メッセージが対処方法を含んでいる。
• 専門用語を避けた文言になっている。
• 注意事項が見える位置に表示されている。

7. READMEチェック

• ツール名、概要、目的、対象利用者が記載されている。
• 利用環境が記載されている。
• 入力データ、出力データが記載されている。
• 個人情報の取扱いが記載されている。
• 動作確認方法、既知の制約、保守範囲が記載されている。

8. JavaScriptチェック（該当時）

• HTML/CSS/JavaScriptのみで動作する。
• 外部通信（fetch等）が不要、または庁内限定である。
• LocalStorage等への保存を不用意に行っていない。
• ブラウザ上でエラー表示が分かりやすい。

9. PowerShellチェック（該当時）

• 実行前に処理対象・出力先を確認できる。
• 上書き・削除の安全策がある。
• ログに個人情報を含めない。
• 可能な範囲で dry-run / WhatIf 相当がある。

10. C#チェック（該当時）

• 実行環境（ランタイム要件）が明記されている。
• GUIまたはメッセージ表示が利用者に分かりやすい。
• 設定ファイル・ログに個人情報を保存しない。
• 配布方法と更新方法が明記されている。
• .cs ファイルが適切に改行・インデントされている。
• .csproj がXMLとして成立している。
• dotnet build 相当の確認を行った（未確認時は理由記録）。
• Officeアプリが必要な場合、READMEに明記した。
• Officeアプリの起動失敗時の対応を文書化した。
• Officeプロセスが残らないよう後処理している。
• 既存出力ファイルの上書き確認がある。
• 入力本文をログ保存していない。
• 外部通信が発生しない。

11. 試作版・検証版・本番相当版の区分

• 試作版（個人利用・短期検証）
• 検証版（部署内テスト）
• 本番相当版（業務利用前提）

区分の理由:

• 利用範囲
• テスト実施範囲
• 残課題の有無

バージョン区分例:

• v0.x.x: 試作版
• v0.9.x: 検証版・リリース候補
• v1.0.0: 初回安定版
• v1.x.x: 改善・機能追加

• deprecated: 廃止予定

• READMEまたは開発報告書に、採用したバージョン区分が記載されている。

12. 文書・ファイル整形チェック

• README.md がraw表示でも読みやすい。
• docs/*.md がraw表示でも読みやすい。
• manuals/*.md がraw表示でも読みやすい。
• development_report.md がraw表示でも読みやすい。
• 見出し、本文、箇条書き、表、チェックボックスが適切に改行されている。
• 各Markdownファイルが数行だけに圧縮されていない。
• Markdown表が複数行で表現されている。
• チェックリストが - [ ] 形式で1項目ずつ改行されている。
• src/index.html が適切に改行・インデントされている。
• src/script.js が適切に改行・インデントされている。
• src/style.css が適切に改行・インデントされている。
• JavaScript / CSS / HTML が1行または数行に圧縮されていない。
• 後任者が読める程度の構造になっている。
• development_report.md がルート直下に1つだけ存在する。
• development_report.md が存在する。
• development_report.md の「作成したファイル」が実際の追加ファイルと一致している。
• development_report.md の「更新したファイル」が実際の変更ファイルと一致している。
• 実際には変更していないファイルを「更新したファイル」に含めていない。
• git差分、コミット差分、または作業ログと development_report.md の内容を照合した。
• ビルド未確認・実機未確認などの未確認事項が明記されている。

確認コマンド例（可能な場合）:

wc -l README.md docs/*.md manuals/*.md development_report.md
wc -l src/*.html src/*.css src/*.js
git status --short
git diff --name-only
git diff --cached --name-only

• git が利用できない環境では、同等の確認方法（作業ログ、差分一覧の目視確認など）でよい。

13. 未対応事項の記録欄

• 未対応事項:
• 理由:
• 影響範囲:
• 暫定対応:
• 恒久対応予定:
• 対応予定日:
• 担当: