以下の条件で、新しい内部ツール開発の初期ドキュメント作成を行ってください。
この段階では、いきなり実装に進まず、まず設計と運用文書を作成してください。
次の文書を必ず参照してから作業してください。
guides/00_policy.mdguides/01_ai_coding_rules.mdguides/02_tool_design_template.mdguides/03_security_privacy_rules.mdguides/04_ui_ux_rules.mdguides/05_release_checklist.mdguides/06_readme_template.mdguides/07_prompt_template.mdguides/08_test_scenarios_template.mdguides/09_operation_handover_template.mdexamples/01_filename_sanitizer/以下の4点だけを個別案件情報として指定し、残りは本リポジトリの方針に従って判断すること。
Vibe-coding実行環境で本リポジトリのGitHub URLを直接読めない場合(例: CONNECT tunnel failed, response 403)は、以下の手順で進めること。
https://yantkys.github.io/lg_toolkit_guide/)。https://raw.githubusercontent.com/YanTKYS/lg_toolkit_guide/main/exports/guide_context.md)。reference/guide_context.md として同梱を依頼し、内容を必ず参照する。guides/ や prompts/ の必要部分のみ追加提示を依頼する。以下を標準構成として扱うこと。
README.md
development_report.md
docs/
tool_design.md
release_checklist.md
test_scenarios.md
operation_handover.md
manuals/
admin_manual.md
operator_manual.md
user_manual.md
src/
(実装方式に応じたファイルを配置)
reference/
guide_context.md
補足:
reference/guide_context.md は同梱方式で進める場合のみ配置する。reference/guide_context.md は必須ではない。README.md
development_report.md
docs/tool_design.md
docs/release_checklist.md
docs/test_scenarios.md
docs/operation_handover.md
manuals/admin_manual.md
manuals/operator_manual.md
manuals/user_manual.md
src/(実装方式に応じた実装ファイル)
docs/design.md、docs/checklist.md、docs/test.md などの短縮名は原則使わない。manuals/operator_manual.md は省略しない(所管部署・運用担当部署・一次対応者向け)。development_report.md に作成し、同一リポジトリ内に複数作成しない。src/ 配下に配置する。実装方式別の src/ 構成例:
静的Webツール:
src/
index.html
script.js
style.css
PowerShellツール:
src/
main.ps1
C# WinFormsツール:
src/
<ProjectName>/
<ProjectName>.csproj
Program.cs
MainForm.cs
必要に応じてその他クラス
Office Interopを使う場合の追記先:
manuals/admin_manual.md(Office前提環境、障害時対応)docs/operation_handover.md(プロセス残存時の一次確認、相談先)guides/12_office_interop_checklist.md の観点を設計・テスト・手順書へ反映する。reference/guide_context.md のみ参照する指定がある場合、外部URLや追加参照先を見に行かない。追加ガイド同梱方式(必要時):
このリポジトリ内の以下の文書を開発ガイドとして参照してください。
- reference/guide_context.md
- reference/11_non_web_tool_patterns.md
- reference/12_office_interop_checklist.md
同梱されている文書のみを参照してください。
外部URLは参照しないでください。
必要な追加ガイドが同梱されていないと判断した場合は、推測で進めず、追加同梱を依頼してください。
src/index.html / src/script.js / src/style.css は、作業完了前に実ファイルを開いて整形状態を確認する。wc -l 相当の確認を実施する。確認コマンド例(可能な場合):
wc -l README.md docs/*.md manuals/*.md development_report.md
wc -l src/*.html src/*.css src/*.js
wc が使えない環境では、同等の確認(raw表示相当での目視確認)でよい。examples/01_filename_sanitizer/ を見て、同程度の粒度で文書案を作る。- [ ] 形式で記載するREADME.md、docs/*.md、manuals/*.md、reference/guide_context.md、報告書にも適用するsrc/index.html、src/script.js、src/style.css は保守性のため改行・インデントするsrc/script.js や src/style.css を1行化しないwc -l または同等確認)development_report.md の作成・更新ファイル一覧が実際の変更内容と一致しているか