今回は,
文書執筆に関する書籍
文書を書く上で気をつける点
英語でも決定版と言える本があります。
今回解説するトピックの多くは文書執筆に関する書籍で共通して記載されている内容です。
文書の執筆で気をつける点とRedPenの設定
本節では,
長さに関する規約
RedPenは長さに関する規約を強制する機能をいくつか提供しています。
文長
文書執筆に関する本にすべてに共通して述べられているのは文は短くという点です。私が文書の校正をお手伝いするときには,
文長をおさえるために,
<validators>
<validator name="SentenceLength>
<property name="max_len" value="120"/>
</validator>
</validators>
文以外の長さ
RedPenでは文長以外に節,
カンマの数
カンマは適切なタイミングで付与すると読者が文を理解するのに役立ちますが,
シンボルの統一
句読点や括弧などの利用するシンボルが統一されていないと,
これらシンボルの統一のために,
シンボル設定の変更
デフォルトの設定を上書きしてシンボルの非統一を検知してみましょう。必要な記述は利用するシンボルと使用してはいけないシンボル
<redpen-conf lang="ja">
<validators>
<validator name="InvalidSymbol" />
</validators>
<symbols>
<symbol name="FULL_STOP" value="." invalid_chars="。."/>
</symbols>
</redpen-conf>
上の例をみるとわかるように,
スペルチェック
RedPenは単語のスペルチェックに関する機能をいくつか提供しています。
カタカナ
カタカナ単語のスペリングに関してRedPenはふたつの機能を提供しています。ひとつはKatakanaSpellCheck機能です。KataKanaSpellCheckはカタカナ単語のスペリングを検査します。もうひとつはKatakanaEndHyphen機能で,
例えば,
RedPenでスペルチェックに関する機能を追加する設定は次の通りです。
<validators>
<validator name="KatakanaSpellCheck" />
<validator name="KatakanaEndHyphen" />
</validators>
英語
RedPenはカタカナ以外に英単語のスペルチェック機能
Spelling機能は辞書をベースにスペルチェックをおこないます。そのため辞書に収録されていないような専門用語が出現するとエラーとなってしまうおそれがあります。そのような場合にはlistプロパティに例外の単語列
Spelling機能とエクセプションリストの例は次の通りです。
<validators>
<validator name="Spelling">
<property name="list" value="Hadoop,SVM"/>
</validator>
</validators>
上の例ではHadoopとSVMが例外単語として登録されています。