Markdownの目的を決める
リポジトリのREADMEには成功への簡潔な道筋が必要です。アーカイブの移行では完全性が優先されるかもしれません。LLMワークフロー用のノートでは、公開用の仕上げよりも見出しと読みやすいテーブルが重視されるかもしれません。変換の前に出力先を決めて、クリーンアップに明確な終点を持たせましょう。
- 想定読者と公開システムを特定する。
- オリジナルとMarkdownのどちらが真実のソースになるかを決める。
- 1つの大きなファイルを複数の目的別ドキュメントに分割するかを決める。
- 出力先が受け付けるプラットフォーム固有の構文を記録する。
ソースドキュメントを準備する
アップロード前に明らかな構造を直す方が、後から推測するより速いです。Wordでは見出しとリストスタイルを使いましょう。スプレッドシートでは、各シートに長方形のテーブルを1つだけ置きます。プレゼンテーションでは、意味のあるスライドタイトルを付け、重要な結論は編集可能なテキストに置きます。
PDFの場合はテキストが選択可能であることを確認します。CSV、JSON、XMLの場合は構文とエンコーディングを検証します。HTMLの場合は、サービスがリモートのWebページを取得または実行することを期待せず、保存済みのコンテンツ中心のドキュメントをアップロードします。
アップロード前に機密性の高い入力を削減する
一時的な処理は保持リスクを下げますが、データ最小化が依然として最良のデフォルトです。結果に不要な場合は、資格情報、個人情報、プライベートなコメント、非表示のワークシート、変更履歴、無関係な付録を削除してください。
構造から詳細へとレビューする
ドキュメントのアウトラインから始めます。読み順や見出しの階層が間違っていれば、個々の句読点を磨くのは無駄な努力になります。次にリストとテーブルを確認し、続いてリンク、画像、コードブロック、通常の空白を確認します。
- アウトライン:H1が1つ、論理的な見出しの推移、繰り返されるページ装飾がない。
- 流れ:段落とスライドが意図した読み順で現れる。
- 構造:リストは連続し、テーブルの列数は一貫している。
- 参照:出力先でリンクが解決され、画像に有用な代替テキストがある。
- 正確性:名前、数字、数式、コードが権威あるソースと一致する。
形式ごとの失敗パターンを把握する
PDFは段組みを混在させたり、ヘッダーを繰り返したりすることがあります。Wordドキュメントはテキストボックスに意味を隠すことがあります。スライドは空間的な関係性に大きく依存します。ワークブックにはMarkdownでは再現できない計算やインタラクティブなビューが含まれます。EPUBはパッケージ相対リンクや末尾注の構造を使うことがあります。
すべてのソースオブジェクトを無理にMarkdownに押し込まないでください。複雑なスプレッドシートは、小さな説明用テーブルとともにソースデータとしてリンクする方がよいかもしれません。アーキテクチャ図は、維持管理された画像とテキスト説明の両方が必要な場合があります。
最終的なレンダラーで検証する
エディターのプレビューはクリーンアップに便利ですが、GitHub、ドキュメントフレームワーク、ナレッジベースでは対応する拡張機能が異なる場合があります。出力先でドキュメントをプレビューまたはビルドし、リンクとスタイルのチェックを実行し、オリジナルを削除する前に専門家のレビュアーに意味を確認してもらいましょう。
- [ ] Heading outline reviewed - [ ] Tables and lists render correctly - [ ] Links and image paths resolve - [ ] Sensitive data removed - [ ] Technical facts verified - [ ] Final renderer checked