変更履歴メモとは?
変更履歴メモとは、文書のある版から次の版で何が変わったかを日付付きでまとめた短い一覧です。どの節が編集され、何が追加または削除され、それはなぜかを記します。自動生成されるものではなく人が書くもので、査読者が新しい版のたびに同じ変更を探し直す手間を省きます。
何を書くか
版の名前と日付、影響を受けたページや節、各変更の1行説明、そして理由または依頼した人を記します。1分で読める程度の短さに保ってください。誤字の修正をすべて並べるより、削除した条項のような判断事項を載せるほうが有用です。
変更を見つける
メモを書くには、まず変更を見つける必要があります。PDF を比較は2つの版の各ページの単語を比べ、異なるページを CSV レポートに一覧するので、確認範囲を絞れます。PDF をテキストに変換は両ファイルのテキストを取り出して箇所を並べて読むのに使え、PDF のページを抽出は変更のあったページだけを小さなファイルにまとめて査読者に渡すのに使えます。 実用のヒント:ファイルのそばに短い記録を置き、版ごとに1行ずつ、日付、ファイル名、変更を依頼した人、レポートで差異のあったページを書いておきます。PDF比較ツールのCSVレポートは、その記録と一緒に保存できます。そうすれば、後から読む人はすべてのファイルを開き直さなくても、最初の版から最終版までの経緯をすばやくたどれます。AuraDocは記録を代わりにつけてくれないので、ご自身の管理システムに保管してください。 もう一つの目安として、変更履歴は専門家でなくても読める短い文章で書きましょう。何を、なぜ変えたのかを一文ずつ添えると、後任の担当者にも意図が伝わります。
ファイルと一緒に保管する
メモは、説明対象の版と同じ場所に、対応する名前で保管するか、共有時に先頭ページとして追加します。新しい版とメモを一緒に受け取った人は、関係するページへすぐに移動できます。
この用語を使うツール
この用語が出てくるガイド
よくある質問
- AuraDoc が変更履歴メモを書いてくれますか?
- いいえ。PDF を比較は同一のページと異なるページを示しますが、各変更の説明は利用者が書きます。
- 変更履歴メモはどこに置くべきですか?
- 説明対象の版の隣に、同じ命名規則で置き、両者が離れないようにします。
- 変更履歴メモは変更履歴の記録機能と同じですか?
- いいえ。変更履歴の記録機能は、編集可能なファイル内の編集を作業中に記録します。変更履歴メモは、完成した版の読者向けに別途書く要約です。