compare-docs について
2つのファイルを比較し、実質的な差異や誤り、不整合を見つけるドキュメント比較スキルです。契約書や財務レポート、改訂文書の確認に向けて、指定した観点を含むレポートを作成します。
主な機能
- 01DOCX、PDF、Markdown、テキストの比較
- 02pandocによるDOCX内容の抽出
- 03数値、日付、条項、定義の確認
- 04構造化されたMarkdown比較レポートの作成
- 05レポートのDOCX変換
活用シーン
- 01改訂された契約書の確認
- 02財務レポートの数値変更の確認
- 03指定した観点での文書バージョン比較
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ lennonli/ compare-docs --skill compare-docsインストール後、Claude Code で/compare-docsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
.gitignoreREADME.mdscripts/compare_docs.pyscripts/comparators/spell_check.pyllm_client.pylogic_check.pyconsistency_check.pyfuzzy_logic.pyscripts/parsers/office_parser.pysection_chunker.pytable_parser.pyscripts/reporters/md_reporter.pyscripts/utils/nlp_utils.py詳細
ドキュメント比較スキル
このスキルは、2つのドキュメントを比較し、実質的な相違点、誤り、不整合を見つけます。法的契約書、財務報告書、改訂版のドキュメントなどに特に役立ちます。
使用方法
# Compare two specific files
/compare-docs file1.docx file2.docx
# Compare with specific focus
/compare-docs file1.docx file2.docx --focus "financial data"
ワークフロー
-
入力の確認:
- 両方の入力ファイルが存在することを確認します。
- ファイルの種類(.docx、.pdf、.md、.txt)を特定します。
-
コンテンツの抽出:
- ファイルが
.docxの場合は、明確なテキスト分析を行うため、pandocを使ってMarkdownに変換します。pandoc -t markdown "file1.docx" -o "file1.md" pandoc -t markdown "file2.docx" -o "file2.md" - ファイルが
.pdfの場合は、利用可能なPDF読み取りツールを使います。
- ファイルが
-
分析と比較:
- 抽出したコンテンツを読みます。
- ドキュメントをセクションごと、またはキーと値ごとに比較します。
- 重点確認項目:
- 数値と日付: 金額、日付、割合、数量に相違がないか確認します。
- 主要条項: 追加、削除、変更された条項を特定します(特に法的文書や契約書の場合)。
- 定義: 定義語に変更がないか確認します。
- 注: 明示的な依頼がない限り、軽微な書式の変更は無視します。
-
レポートの作成:
- 次の構成でMarkdownレポート(
comparison_report.md)を作成します。- 概要: 比較結果の簡潔な概要。
- 重大な相違点(高リスク): データの不一致、条項の欠落、義務の矛盾。
- 実質的な変更: 意味や範囲の変更。
- 文体/書式の変更: (任意)意味を変えないレイアウトや表現の変更について簡潔に記載します。
- 推奨事項: 調査結果に基づく、実行可能なアドバイス。
- 次の構成でMarkdownレポート(
-
出力の書式設定と納品:
pandocを使ってMarkdownレポートをプロフェッショナルな.docxドキュメントに変換します。pandoc "comparison_report.md" -o "Comparison_Report.docx"- ファイルを開く: 生成したドキュメントを自動的に開き、ユーザーがすぐに確認できるようにします。
- macOSの場合:
open "Comparison_Report.docx" - Windowsの場合:
start "Comparison_Report.docx" - Linuxの場合:
xdg-open "Comparison_Report.docx"
- macOSの場合:
- レポートの保存先をユーザーに知らせます。
-
クリーンアップ:
- 中間生成ファイル(変換した.mdファイルなど)を削除し、ワークスペースを整理します。
出力例の構成
比較レポート
1. エグゼクティブサマリー
...
2. 主な不一致
| 項目 | ファイルAの値 | ファイルBの値 | 影響 |
|---|---|---|---|
| 収益 | $10M | $12M | 重大 |
| ... | ... | ... | ... |
3. 条項の詳細分析
...
コメント
Markdown 対応