miku-docx2md

実文書での品質確認

この文書は、実際の .docx ファイルで変換品質を確認するための手順です。

確認結果を repository-safe な形で記録する場合は、real-document-validation-template.md を使います。

目的

fixture test は既知の挙動を確認します。実文書での確認は、実用的な Word 文書で初めて見つかる変換ギャップを拾うために行います。

目的は Word の見た目を完全再現することではありません。文書構造が読みやすい Markdown として残ることを確認します。

検証用ドキュメント

形の違う .docx を少数用意します。

推奨カテゴリ:

private または sensitive な文書は repository に commit しません。

CLI 確認

各文書で実行します。

npm run cli -- ./sample.docx --out ./sample.md --summary --summary-out ./sample.summary.txt

画像を含む文書では asset 出力も確認します。

npm run cli -- ./sample.docx --out ./sample.md --assets-dir ./sample.assets --summary --summary-out ./sample.summary.txt

診断用出力も確認します。

npm run cli -- ./sample.docx --out ./sample.debug.md --debug

確認観点:

triage 方針

実文書で問題を見つけたら、code を変える前に分類します。

bug を直す場合は、できるだけ focused fixture test を追加します。

release gate

release 前に実行します。

npm run build
npm run test:unit

あわせて確認します。

ブラウザ UI の実文書確認は、分離済みの miku-docx2md-web repository で実施します。