エンジニアのための日本語校正ツール

## はじめに

みなさん、日本語って難しいですよね。

エンジニアは日常的に日本語文章を制作します。しかし文章の品質を保つのはとても難しい作業です。この記事ではエンジニアが日本語文章を校正する上で助けになるツールを紹介します。私たちはエンジニアなので、難しい作業こそツールで楽をしましょう。

### よい日本語文章とは

正しく、簡潔で、読みやすい日本語は文章の理想です。この理想を要素ごとに分解すると以下のようになります。

-   正しい
    -   誤字脱字がない
    -   文法に誤りがない
    -   内容に誤りがない
-   簡潔
    -   冗長な表現がない
    -   1文で1つの事柄を述べる
    -   言いたいことを先に出す
-   読みやすい
    -   表記の揺れがない
    -   センテンスの長さが適切
    -   漢字を適度に開く
    -   表現に曖昧さがない

### 文章を良くする作業

こうした文章の品質向上に必要なのが次の3つの作業です。

-   校正
    -   制作上の誤りを訂正する作業。原稿と校正刷のズレを探し、誤字脱字や文法上の誤りを訂正する。
-   校閲
    -   内容を訂正する作業。事実誤認やデータの誤り、不適切な表現を訂正する。
-   推敲
    -   文章のブラッシュアップ作業。上の2つの作業と異なり、筆者自身が行う。

このうち校正はある程度の自動化が可能です。校閲と推敲は内容の修正ですので自動化が難しいですが、校正であればツールの補助を受けられます。

### この記事の前提

#### 想定する読者

この記事は、日本語文章を制作するエンジニアを対象としたものです。

#### 想定する作業

この記事では、次の2つの作業を対象とします。

-   技術系ブログ記事の執筆
-   オープンソースソフトウェアの日本語ドキュメント整備

ツールを選ぶ前提として、以下の2点を条件としました。

-   マークダウン形式のテキストを入力できる
-   プログラムのソースコード、URLを入力してもエラーにならない

これらの条件に合わないツールは、どれだけ品質が高くとも技術系ドキュメントの制作には使えません。

### してはいけないこと

❌
**守秘義務のある文章はWebアプリケーション型の校正ツールに入力してはいけません。**

守秘義務契約の内容にもよりますが、厳密に解釈した場合Webサービスに入力しただけで情報流出と判断される場合があります。Webアプリケーション型の校正サービスを利用する場合、一般公開する文章だけを入力しましょう。

[参考記事 enno.js : 注意](https://enno.jp/help)

守秘義務が存在する日本語を機械的にチェックしたい場合は、[textlint](https://github.com/textlint/textlint)の導入を検討してください。

## ツールの紹介

ここからは校正ツールの紹介をします。それぞれのツールに得意なことがありますので、その点にフォーカスしてご紹介します。

### テキスト校正くん

![テキスト校正くんのスクリーンショット](https://github.com/ics-creative/project-japanese-proofreading/raw/master/images/demo.gif)

#### 基本情報

-   [公式サイト](https://ics.media/entry/18859/)
-   [ダウンロードサイト](https://marketplace.visualstudio.com/items?itemName=ICS.japanese-proofreading)
-   費用 : 無料
-   動作環境 : Visual Studio Code機能拡張

#### 得意なこと

-   リアルタイムチェック
-   固有名詞のチェック
-   助詞の連続など基本的な文法チェック

テキスト校正くんはVisual Studio Codeの機能拡張です。プレーンテキストかマークダウン形式のファイルの日本語校正をします。

テキスト校正くんの最大の利点はリアルタイムチェックです。タイピング中に文章を次々とチェックします。またIT系の固有名詞辞書を抱えており、サービス名やソフトウェア名の表記揺れを補正します。

あなたがVisual Studio Codeを普段から使っているならぜひインストールすべき機能拡張です。

### Qiita Typo Checker

![Qiita Typo Checkerのスクリーンショット](https://www.evernote.com/l/AAmrnPnKAClCp4UWhAxQZWb09CwQNOoHsWcB/image.jpg)

#### 基本情報

-   [公式記事](https://qiita.com/khsk/items/fea81fb4dfd41b7eaf19)
-   費用 : 無料
-   動作環境 : ブラウザー

#### 得意なこと

-   ユーザーIDによる横断検索

Qiita Typo CheckerはWebアプリケーション型の日本語校正ツールです。QiitaのユーザーIDを入力することで、そのユーザーの全記事を一括チェックする機能があります。

### enno.js

![enno.jsのスクリーンショット](https://enno.jp/assets/help_02-3f82669c2b1ef25a7401d704c55768fcbc7e0fa6c3ec6c1986b44e2c631f0b60.png)

#### 基本情報

-   [公式サイト](https://enno.jp/)
-   費用 : 無料
-   動作環境 : ブラウザー

#### 得意なこと

-   曖昧な表現の指摘
-   変換ミスの指摘
-   英単語スペルミスの指摘

enno.jsはWebアプリケーション型の日本語校正ツールです。曖昧な表現、変換ミス、スペルミスの辞書を抱えており、技術系に限らず広く日本語文章を校正できます。

とくに曖昧な表現の指摘が優秀です。たとえば「確認」という単語には複数の用法があるので文脈に合わせて置き換えるか、言葉を補うことを推奨します。広い意味のある言葉は便利ですが、読者に誤解と混乱を与えます。1つの意味にしかとれない文章は読みやすくなります。

### ATOKクラウドチェッカー

![ATOKクラウドチェッカーのスクリーンショット](https://www.evernote.com/l/AAlpbqBr5A9L7r1ghHdQy02CgprO4z8Nj2QB/image.png)

#### 基本情報

-   [公式サイト](https://jproofreading.atok.com/)
-   費用 : 月額500円（税抜）
-   動作環境 : ブラウザー

#### 得意なこと

-   代替案の提示まで踏み込んだ校正

ATOKクラウドチェッカーは[JustSystem](https://www.justsystems.com/jp/)が提供するクラウドサービスです。[ATOKパスポートプレミアム](https://www.justsystems.com/jp/products/atok-passport/)というサブスクリプションサービスの一部として提供されています。今回ご紹介するツールの中では唯一の有償サービスです。

他のツールと同様に曖昧な表現や変換ミス、スペルミスの指摘をしますが、ATOKクラウドチェッカーはさらに踏み込んで代替表現の提案をします。類語辞書にあたる必要がなくなり、文章の修正時間を短縮できます。

校正能力は今回ご紹介したツールでもっとも強力ですが、URLやコードを本文の一部として認識してしまいます。エラーを起こさないので無視はできますが、この点は残念です。

#### 利用上の注意

このサービスは、バックスペース制御文字`backspace (U+0008)`を入力するとエラーを起こします。Visual Studio Code + macOS環境では、日本語変換時に誤ってバックスペース制御文字を入力してしまうバグがあります。`ATOKクラウドチェッカーが利用できません。しばらくしてから再実行してください。`というダイアログが表示されたら、バックスペース制御文字の混入を疑ってみてください。

参考記事
[Visual Studio Code の日本語問題まとめ : バックスペース問題](https://qiita.com/EbXpJ6bp/items/e6a0ed52bdcb60bfd145#%E3%83%90%E3%83%83%E3%82%AF%E3%82%B9%E3%83%9A%E3%83%BC%E3%82%B9%E5%95%8F%E9%A1%8C)
[【VSCode】Macで文章作成中に制御文字（0x08）が勝手に混ざるので、とりあえず対策した](https://dev.classmethod.jp/etc/vscode-mac-control-character-0x08/)

## 個人的な感想

-   自分で自分の文章を校正する難しさを実感しました。使い心地を試すため、過去の記事をツールにかけたら大量の指摘が出てちょっと凹みました。
-   テキスト校正くん + enno.jsの組み合わせで執筆中の原稿をチェックし、Qiita Typo Checkerで定期的に自分のアカウントを添削すると相当日本語の品質が上がります。自分でも読みやすくなったのが実感できます。
-   ATOKパスポートは費用対効果を考えると格安です。個人的には、もしもあなたが1か月に1日以上PCで日本語を書くなら絶対に契約すべきだと思います。

以上、ありがとうございました。