lg_toolkit_guide

01_start_new_tool_from_docs.md

以下の条件で、新しい内部ツール開発の初期ドキュメント作成を行ってください。
この段階では、いきなり実装に進まず、まず設計と運用文書を作成してください。

前提(必須参照)

次の文書を必ず参照してから作業してください。

最小依頼プロンプト

以下の4点だけを個別案件情報として指定し、残りは本リポジトリの方針に従って判断すること。

ガイドを参照できない場合の対応

Vibe-coding実行環境で本リポジトリのGitHub URLを直接読めない場合(例: CONNECT tunnel failed, response 403)は、以下の手順で進めること。

  1. まず GitHub Pages を確認する(https://yantkys.github.io/lg_toolkit_guide/)。
  2. Pagesが読めない場合は raw を確認する(https://raw.githubusercontent.com/YanTKYS/lg_toolkit_guide/main/exports/guide_context.md)。
  3. rawも読めない場合でMCP Fetchが使えるなら、MCP FetchでPagesまたはraw取得を試す。
  4. MCP Fetchでも読めない場合は、reference/guide_context.md として同梱を依頼し、内容を必ず参照する。
  5. そのうえで不足情報があれば、guides/prompts/ の必要部分のみ追加提示を依頼する。
  6. ガイド未参照状態では、実装を開始しない(推測実装禁止)。

目的

作成する成果物(実装前)

  1. ツール設計書
  2. README
  3. リリース前チェックリスト
  4. テストシナリオ
  5. 運用引継ぎメモ
  6. 管理者向け / 運用担当部署向け / 利用者向け手順書(3種類すべて)
  7. 実装方針(採用技術、非採用技術、段階的実装計画)

作成先ツールリポジトリの標準構成例

以下を標準構成として扱うこと。

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

補足:

標準成果物ファイル名(原則)

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/(実装方式に応じた実装ファイル)

実装方式別の 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を使う場合の追記先:

guide_contextのみ参照する比較テスト時の追加ルール

追加ガイド同梱方式(必要時):

このリポジトリ内の以下の文書を開発ガイドとして参照してください。

- reference/guide_context.md
- reference/11_non_web_tool_patterns.md
- reference/12_office_interop_checklist.md

同梱されている文書のみを参照してください。
外部URLは参照しないでください。

必要な追加ガイドが同梱されていないと判断した場合は、推測で進めず、追加同梱を依頼してください。

整形状態の実確認(作業完了前に必須)

確認コマンド例(可能な場合):

wc -l README.md docs/*.md manuals/*.md development_report.md
wc -l src/*.html src/*.css src/*.js

進め方

  1. まず業務課題と対象利用者を確認する。
  2. 参照文書と examples/01_filename_sanitizer/ を見て、同程度の粒度で文書案を作る。
  3. 文書案の末尾に「承認依頼事項(確認してほしい点)」を付ける。
  4. 利用者の承認を得るまでは実装に進まない

入力情報(この下を埋めて使用)

最小入力(必須)

追加入力(任意)

出力形式

作業報告に必ず含める項目