06_readme_template.md - 内部ツール README テンプレート
このテンプレートは、guides/00_policy.md と guides/01_ai_coding_rules.md を前提に作成すること。
ツール名
(例)CSV整形補助ツール
1. 概要
2. 目的
- どの業務の、どの手間を減らすためのツールかを記載する。
3. 対象利用者
- 想定する利用者(例: ○○課職員、庶務担当者)を記載する。
4. 利用環境
- OS: Windows(想定バージョン)
- ネットワーク: 閉域 / 庁内ネットワーク
- 必要ソフト: (例)標準ブラウザ / PowerShell / .NET ランタイム
- 管理者権限: 不要(原則)
5. できること
6. できないこと
7. 使い方
- 起動方法
- 入力方法
- 実行手順
- 結果確認方法
8. 入力データ
- 対応形式(例: CSV, TXT)
- 必須項目
- 文字コード
- 注意点
9. 出力データ
- 出力形式
- 出力先
- ファイル命名規則
- 上書き有無(原則なし)
10. 個人情報の取扱い
- 保存する/しないの方針
- ログへの出力有無
- 一時ファイルの扱い
- 利用後のデータ管理注意
11. 外部ライブラリ
- 使用なし / 使用あり(名称、バージョン、同梱方法、ライセンス)
12. 注意事項
- 元ファイルを直接変更しないこと
- 最終判断は利用者が行うこと
- 業務運用ルールに従うこと
13. 動作確認方法
14. バージョン
- 現在バージョン:
v0.0.0
- 更新日:
YYYY-MM-DD
15. 更新履歴
16. 既知の制約
17. 保守範囲
- どこまで保守対象か(例: 部署内利用のみ、対象OS範囲)を記載する。
18. 問い合わせ先または管理者欄