5.4. テキストの推敲と校正

HOWTO の文章を書き終わったら、次は、それを推敲して磨きをかけます。 推敲の善し悪しで、まずまずの HOWTO か、すばらしい HOWTO かが決まります。

推敲の目的は、文書に忍び込んだ余計な事柄を削除することです。HOWTO を 注意深く読み返して、その主題についての読者の理解に役立たないものは、バッサリ と削ってください。文章を書いているうちに脱線するのは、著者として自然なこと です。今は、それを訂正するときです。

推敲と校正の際は、スペルミスや typo といった明らかなミスをチェック しなくてはなりません。しかし、その際、もっと深くて、見つけにくい、 必要な情報の "欠落" も同時にチェックすべきです。セクションの 内容がそのセクションのタイトルと正確に合致しているかどうか確認してください。

文書の質と正確さについて完全に満足のいくものができたら、次にそれを 誰かに渡して、第三者として校正してもらってください。自分では作品に近すぎて、 根本的な欠点を理解できないことがあるからです。

こうした校訂は、ある意味で、ソフトウェア開発のコード・レビューの ようなものです。プログラマが自分たちで作ったコードをレビューしてもあまり意味 がないでしょう? 作者が自分たちで作った文書を校訂しても、それ以上意味のある 結果を得られるでしょうか? そうしたわけで、友人をリクルートするか、 ldp-discuss メーリングリストに投稿してボランティアを捜し、寄稿する前に HOWTO を校正するようにしてください。

Note: もし自分では精通していない言語で文書を書いている場合は、その言語に 精通した校正者を捜すことを強くお薦めします。技術文書では、他のどんな タイプの文書よりも、特段に正確な文法と語彙を使わなければなりません。 言葉の誤用は、それがどれほど致し方のない意図せざる誤用であったとしても、 あなたの HOWTO の価値を低下させてしまいます。