Design Document Analysis
用于读取一个或多个 Excel 设计文档并调用 VS Code Copilot 做业务分析,最后同时输出中文与日文结构化 Markdown 报告,支持继续作为 Copilot 附件用于代码 Review。
主要功能
- 状态栏常驻入口:启动后在底部状态栏显示插件图标。
- Excel 多选:支持一次选择多个
xls、xlsx、xlsm 文件并汇总分析。
- 标签过滤:可输入标签字符串筛选相关行;留空则分析全部内容。
- 上下文抽取:记录匹配行所属源文件、Sheet 与章节标题,增强理解。
- 删除线识别:提取单元格中删除线内容,并以
~~删除内容~~ 标记。
- 模型选择:调用 Copilot 前可选择用于分析的模型。
- 双语输出:保存时会生成中文报告和日文报告,日文报告使用
.ja.md 后缀。
- 输出可命名:保存时可自定义中文报告文件名(自动补
.md 后缀)。
- 路径记忆:记住上一次 Excel 目录和输出目录。
- 自动打开开关:生成后可自动打开报告(可在设置中关闭)。
环境要求
- VS Code 版本:
^1.103.0
- 已启用并可使用 GitHub Copilot
使用方式
- 点击状态栏中的
设计文档 图标。
- 选择待分析的 Excel 文件(可一次选择多个)。
- 输入标签(可选,留空表示全部)。
- 选择 Copilot 分析模型。
- 选择输出目录。
- 输入中文报告文件名(例如
需求评审结果 或 review.md)。
- 插件会同时生成中文报告和日文报告,例如
review.md 与 review.ja.md。
- 生成完成后,按配置自动打开生成的 Markdown 文件。
输出说明
生成的 Markdown 报告包含以下内容:
- 基本信息(源文件列表、标签、分析行数、模型、时间)
- 删除线标记信息(是否包含删除线内容,删除内容以
~~ ~~ 呈现)
- 抽取上下文明细(源文件、Sheet 页、章节标题、行号、数据)
- 结构化业务分析结果
- “代码 Review 附件指令”段落(可直接复制给 Copilot)
- 附件上下文块(便于 Copilot 快速理解设计背景)
扩展设置
designdocumentanalysis.autoOpenAnalysis
- 类型:
boolean
- 默认值:
true
- 说明:生成 Markdown 后是否自动打开文件。
注意事项
- 当 Excel 内容过大或多文件汇总内容过长时,输入给 Copilot 的摘要会被截断(插件会在报告中标记“输入已截断”)。
- 选择模型后,如果当前环境没有权限调用该模型,会给出提示并终止本次分析。
- 对于富文本单元格,删除线部分会在输出中标记为
~~内容~~,并参与模型分析。
- 日文版报告由 Copilot 基于中文版报告翻译生成,会保留 Markdown 结构、路径、配置键与代码标识符。
发布信息
许可证
本项目使用 MIT License,详见项目根目录下的 LICENSE 文件。
Release Notes
1.0.6
- 支持一次选择多个 Excel 文件,并将多个文件中的匹配内容汇总后交给 Copilot 分析。
- 输出流程改为选择文件夹并输入中文报告文件名后,同时生成中文报告和
.ja.md 日文翻译报告。
- 优化 Copilot 业务分析提示词,强化跨文件归纳、业务流程、数据约束、风险、待确认问题与代码 Review 关注点。
- README 更新中文说明,并追加日文说明。
1.0.5
- 新增删除线内容识别:抽取单元格内被删除线标记的文本并格式化为
~~内容~~。
- 在分析提示与报告中明确删除线内容,确保模型和开发者都能识别“已删除”与“保留”内容。
1.0.4
- 抽取匹配行时同步识别 Sheet 与章节标题,输出上下文明细。
1.0.3
- 支持多标签筛选(逗号/中文逗号分隔,任一命中即有效)。
- 记住上次选择的 Copilot 模型并默认选中。
- 支持输出文件自定义命名与自动补
.md 后缀。
- 新增 MIT License 文件并完善发布信息。
1.0.2
- 生成报告结构优化,支持作为 Copilot 附件用于代码 Review。
- 新增“生成后自动打开报告”配置开关。
- 支持记住上次 Excel/输出目录。
- 支持选择 Copilot 分析模型。
- 交互与错误信息中文化。
Design Document Analysis(日本語)
1つまたは複数の Excel 設計書を読み取り、VS Code Copilot を呼び出して業務分析を行い、中国語版と日本語版の構造化 Markdown レポートを同時に出力します。生成されたレポートは、後続のコードレビューで Copilot の添付コンテキストとして利用できます。
主な機能
- ステータスバー常駐エントリ:起動後、下部ステータスバーに拡張機能のアイコンを表示します。
- Excel 複数選択:複数の
xls、xlsx、xlsm ファイルを一度に選択して集約分析できます。
- タグフィルター:タグ文字列を入力して関連行を絞り込めます。空欄の場合はすべての内容を分析します。
- コンテキスト抽出:一致した行の元ファイル、Sheet、章タイトルを記録し、理解を補強します。
- 取り消し線の認識:セル内の取り消し線付きテキストを抽出し、
~~削除内容~~ としてマークします。
- モデル選択:Copilot を呼び出す前に分析用モデルを選択できます。
- 二言語出力:中国語レポートと日本語レポートを生成し、日本語レポートには
.ja.md 接尾辞を付けます。
- 出力ファイル名指定:中国語レポートのファイル名を指定できます(
.md 接尾辞は自動補完)。
- パス記憶:前回使用した Excel ディレクトリと出力ディレクトリを記憶します。
- 自動オープン設定:生成後にレポートを自動で開くかどうかを設定できます。
要件
- VS Code バージョン:
^1.103.0
- GitHub Copilot が有効で利用可能であること
使い方
- ステータスバーの
设计文档 アイコンをクリックします。
- 分析対象の Excel ファイルを選択します(複数選択可能)。
- タグを入力します(任意。空欄の場合はすべて)。
- Copilot の分析モデルを選択します。
- 出力ディレクトリを選択します。
- 中国語レポートのファイル名を入力します(例:
需求评审结果 または review.md)。
- 拡張機能は
review.md と review.ja.md のように、中国語版と日本語版を同時に生成します。
- 生成後、設定に従って Markdown ファイルを自動で開きます。
出力内容
生成される Markdown レポートには、次の内容が含まれます。
- 基本情報(元ファイル一覧、タグ、分析行数、モデル、生成時刻)
- 取り消し線情報(取り消し線付き内容の有無、削除内容は
~~ ~~ で表示)
- 抽出コンテキスト詳細(元ファイル、Sheet、章タイトル、行番号、データ)
- 構造化された業務分析結果
- 「コードレビュー添付指示」セクション(Copilot に直接コピー可能)
- 添付コンテキストブロック(Copilot が設計背景を素早く把握するための情報)
拡張機能設定
designdocumentanalysis.autoOpenAnalysis
- 型:
boolean
- 既定値:
true
- 説明:Markdown 生成後にファイルを自動で開くかどうか。
注意事項
- Excel の内容が大きい場合、または複数ファイルの集約内容が長い場合、Copilot に渡す概要は切り詰められます(レポートに「入力は切り詰め済み」と記録されます)。
- モデル選択後、現在の環境でそのモデルを呼び出す権限がない場合は、メッセージを表示して分析を終了します。
- リッチテキストセルの取り消し線部分は
~~内容~~ として出力され、モデル分析にも含まれます。
- 日本語版レポートは Copilot が中国語版レポートを翻訳して生成します。Markdown 構造、パス、設定キー、コード識別子は保持されます。
リリース情報
ライセンス
本プロジェクトは MIT License を使用しています。詳細はプロジェクトルートの LICENSE ファイルを参照してください。
Release Notes
1.0.6
- 複数の Excel ファイルを一度に選択し、各ファイルの一致内容を集約して Copilot で分析できるようになりました。
- 出力フローを、フォルダー選択と中国語レポート名入力後に、中国語レポートと
.ja.md 日本語翻訳レポートを同時生成する方式に変更しました。
- Copilot 向け業務分析プロンプトを改善し、複数ファイルの集約、業務フロー、データ制約、リスク、確認事項、コードレビュー観点を強化しました。
- README の中国語説明を更新し、日本語説明を追加しました。
1.0.5
- 取り消し線付き内容の認識を追加しました。セル内で取り消し線が付いたテキストを抽出し、
~~内容~~ として整形します。
- 分析プロンプトとレポートで取り消し線付き内容を明示し、モデルと開発者が「削除済み」と「保持中」の内容を区別できるようにしました。
1.0.4
- 一致行を抽出する際に、Sheet と章タイトルも同時に認識し、コンテキスト詳細として出力します。
1.0.3
- 複数タグによるフィルターに対応しました(半角カンマ/全角カンマ区切り、いずれかに一致すれば有効)。
- 前回選択した Copilot モデルを記憶し、既定選択として表示します。
- 出力ファイル名のカスタマイズと
.md 接尾辞の自動補完に対応しました。
- MIT License ファイルを追加し、公開情報を整備しました。
1.0.2
- 生成レポート構造を改善し、Copilot のコードレビュー添付資料として利用できるようにしました。
- 「生成後にレポートを自動で開く」設定を追加しました。
- 前回の Excel/出力ディレクトリを記憶します。
- Copilot 分析モデルの選択に対応しました。
- インタラクションとエラーメッセージを中国語化しました。
| |