はじめに
本連載ではRedPenという自動文書検査ツールの紹介とRedPenを利用した技術文書の校正方法について説明します。RedPenはオープンソースプロジェクトで,
RedPenは技術文書をターゲットにした文書の自動検査ツールです。技術文書にはマニュアルやチュートリアル,
技術文書の特徴
RedPenが対象とする技術文書ですが,
最大の違いは,
技術文書に求められるわかりやすさとは単純には内容が理解しやすいことを意味します。拡大解釈すると,
日記等と違って技術文書は自分以外の第三者が読むため,
RedPenを開発した動機
ソフトウェアエンジニアはプログラムだけではなく,
ソフトウェアツールを開発する際には多くのテストを書きます。またCheckStyleやlintなどの静的解析ツールを利用してフォーマットのエラーを自動で検知する環境を整えます。テストを整備したり静的解析ツールを導入することで,
一方私が文書を書いている時には安心感はありません。技術文書の執筆環境にはテストもありませんし,
このような状況に対して,
以下,
RedPenの特徴
前項で述べたようにRedPenはプログラムの静的解析ツールに相当する機能を技術文書に対して提供します。具体的には文長のチェックや不正な表現を検知などわかりやすさに寄与する機能と,
言語非依存
RedPenはどの自然言語
柔軟な設定
RedPenが対象とする技術文書の規約は所属組織によって大きく異なります。RedPenは組織の規約に対応できるように設定が柔軟に行える仕様となっています。
コマンド実行
RedPenは単一コマンドで実行できます。そのため,
RedPenを使ってみる
ではRedPenを使用してみましょう。RedPenはUnix系のOSとWindowsで動作します。今回はUnix系のOS
必要なソフトウェア
RedPenは次のソフトウェアを必要とします。
- Java
(バージョン 8)
ダウンロードと解凍
RedPenをダウンロードします。RedPenのリリースページからダウンロードできます。
ダウンロードされたファイルを次のコマンドで解凍します。
$tar xvf redpen-cli-1.0-assembled.tar.gz x redpen-cli-1.0/lib/redpen-core-1.0.jar x redpen-cli-1.0/lib/kuromoji-0.7.7.jar x redpen-cli-1.0/lib/commons-io-2.2.jar ...
結果,
インストール
RedPenをインストールします。インストールと言ってもRedPenのソースファイルをコピーするだけです。たとえばRedPenを/usr/
$cp -r redpen-cli-1.0 /usr/local/redpen
続いてRedPenのインストールディレクトリを環境変数PATHに追加します。次のようにredpen/
export PATH=$PATH:/usr/local/redpen/bin
他のシェルを利用している場合も同様にPATHにredpenディレクトリを追加してください。以上でインストールは完了しました。