研究ドキュメント実務ノート作業の記録 / 日本語 + English
原資料と、仕上がったノートのあいだ

文書ワークフローを同僚に渡すとき、何を残すか

· 運営・関連性の開示

公開 · 更新

編集上の更新:保守者の明示、公開・更新日、同サイトの関連記事を追加しました。作業例は変更していません。

記録されていない前提を見つける近道は、作業を別フォルダー、あるいは別の人に移すことです。作者のDownloadsでしか動かない手順は、まだ引き継げません。大きな梱包システムを作らなくても改善できます。

役割でファイルを分ける

原PDFは変更せずに残します。計算機JSONとページレシピJSONは編集可能な指示、生成したPDFと端末レポートは再生成できる出力と考えます。Markdownの説明はローカル図と一緒に置きます。テキストだけ動かすと、意味の一部が離れてしまうためです。

handoff/
  originals/
  instructions/
  notes/summary.md
  notes/figures/context.svg
  outputs/

どの元資料をAにするか、利益はどの期間か、ノートを点検するコマンドは何かを、短い文章で記します。Page RecipeのJSONには名前とページ数はありますがPDF本体はありません。Share SliceのJSONにも数値条件はありますが、根拠となる会社開示はありません。どちらもoriginalsの代わりにはなりません。

移動テストを行う

  1. handoff全体を、プロジェクト内の別の場所へコピーします。
  2. その外側から、Markdown CLIでhandoff/notes/summary.mdを点検します。相対パスは端末の場所ではなく、ノートの隣を基準に解決されるはずです。
  3. コピーしたPDFをPage Recipeで選び、別名を確認してレシピを読み込みます。新しい出力名で保存します。
  4. 株数シナリオも再読込し、最終行をノートの結果および単位と照合します。

合格条件は「道具がすべて開いた」ことではありません。移動後にも同じ数値シナリオ、同じ元ページ順、使えるローカルリンクが得られることです。本文が表示されても、図が欠けていれば引き継ぎは不十分です。

環境の記録は小さく

CLIとビルドにはNode 24以降が必要と記し、各リポジトリでnpm ciを使ってlockfileに従います。二つのブラウザーツールにはJavaScriptと入力を扱えるメモリーが必要です。認証情報、ブラウザープロファイル、非公開の顧客文書、node_modulesを公開用パックに入れないでください。

論文の変換がまだ必要なら、関連するKolmoPDFのクラウドサービスは別の処理境界です。そこでは文書をアップロードします。この演習はローカルファイルから始め、その境界を黙って変えるものではありません。