ドキュメントを書く仕事

最近、手順書などの資料をアルバイトスタッフにお願いすることが多くなりました。手順書を作るのはアルバイトからすると、思っていたよりも大変な事が多いようです。特にエンドユーザが実施するような手順を書こうと思うと、コンピュータリテラシーが高くなくても理解できるように記述する必要があります。そうなると必然的に物量が多くなってきて、ミスや誤記が増えてしまいますよね。

また、人によって言い回しが違ったり、独自のルールで書いてしまうこともあります。ある程度会社として決まった記述ルールのもとで書いてもらうのがいいと思うのですが、それをいちいち教えたりチェックしたりするのは楽しい仕事ではありません。

文章校正ツールを使おう

そこで、自動で文章校正をしてくれるツールはないものかと調査してみました。幾つかご紹介したいと思います。

とりあえず手軽に文章校正してみたい！

日本語校正サポート (Webサービス)
http://www.kiji-check.com/

Webで公開されている文章校正ツールです。導入やセットアップの必要はなく、URLにアクセスするだけで手軽に使うことができます。校正ルールも充実しており、GUIで修正すべき箇所をわかりやすく指摘してくれます。
ただ、カスタマイズができないため独自の校正ルールを導入するようなことはできません。

自分でカスタマイズした校正ルールを使いたい！

textlint
https://github.com/textlint/textlint

テキストファイル向けのLintツールです。基本的にコマンドラインで動作したり、Atomなどのエディタのプラグインとして提供されていたりします。自分でルールを作成したり、公開されているルールを組み合わせることでオリジナルの文章校正ツールに仕立てあげることができます。

インストール方法等は下記URLをご覧ください↓
http://efcl.info/2015/09/10/introduce-textlint/

Eyes, JAPANのブログ記事を校正チェックしてみた

とりあえず、textlintの開発者azuさんが作った日本語の基本的なルールと、日本翻訳連盟のJTF日本語標準スタイルガイド（翻訳用）をルール化したものを入れて試してみました。

校正対象となるサンプルの文章として、Eyes, JAPANの7月の記事を使ってみることにしましょう (笑)

修正箇所は以下の用に表示されます

算用数字は「半角」で表記します。
本文を敬体(ですます調)に統一して下さい。
一つの文で”、”を3つ以上使用しています。

などの指摘がありますね。あくまで採用しているルールにおける校正なので、これが絶対正しい、というものではありません。

ちなみにコマンドに —fix をつけると自動である程度の修正をしてくれます。

Eyes, JAPANで一番綺麗な文章を書くスタッフは誰だ!?

7月の記事だけですが、勝手に全て校正チェックさせていただきました。7月のブログ担当者で最も綺麗な文章 (文字数に対する修正箇所の割合が最も低い) を書いたのは、、、

青木くんです！

7/21 続・わかるコードを書くために 
http://www.nowhere.co.jp/blog/archives/20160721-144346.html

記事の文字数1368に対して、修正箇所はたった1つだけ！

偶然？にもReadable Codeの記事でした。リーダブルなコードを書けるエンジニアは当然リーダブルな文章も書けるということですね！すばらしい。

最後に

今回はあくまで私が適当に選んだルールでの校正でしたが、文章校正ツールを使う際はドキュメントの種類に応じてルールを選んでいくのが正しい使いかたです。今後は美しい読みやすいドキュメントを作るために、文章校正のCIなどにも取り組んでいければと思います。