textlint校正ツールの技術文書向けルールをカスタマイズする方法

textlint と Re:VIEW

textlint と Re:VIEW

textlint校正ツールで日本語原稿チェック

2018年5月、Windows10のtextlint校正ツールにより技術文書向けルールでRe:VIEW日本語原稿をチェックしました。textlintにRe:VIEWプラグインルールプリセットをインストールして拡張し、ルールをカスタマイズしました。

ルールプリセットは、技術文書向けのtextlint-rule-preset-ja-technical-writingを使用しました。

textlintのインストールと設定については、下記ブログを参照してください。

textlint校正ツールでRe:VIEW日本語原稿をチェックする方法

textlintルールプリセットをローカル(開発環境)にインストールします。ルールは、日本語で記述した技術文書向けのtextlint-rule-preset-ja-technical-writing Build Status Gitterにします。

ルールの詳細な設定を行わずデフォルト値で有効にしました。

.textlintrcを示します。

Re:VIEWサンプル原稿

textlintで原稿の校正を行うサンプル原稿を作成します。ファイル名はtest.reで、UTF-8エンコードLF改行コードで作成します。
このサンプル原稿は、ルールチェックを試すために故意に日本語の問題を混入しています。

サンプル原稿のチェック

技術文書向けルールプリセット(textlint-rule-preset-ja-technical-writing)は、デフォルト値で有効にしています。

textlint 指摘

textlint 指摘



指摘
9 「?」を使用することを拒否

Re:VIEWを知っていますか?


指摘
10 弱い表現: “かも” が使われています
10 「!」を使用することを拒否

Re:VIEWは素晴らしいツールかもしれません!


指摘
13 一つの文で”、”を3つ以上使用しています

Re:VIEWは、電子書籍向けの簡易なマークアップ言語で、
記述したテキストファイルをEPUBやPDFなどの形式に変換する、
ツールセットです。

「○○で、△△する、□□です。」という問題のある日本語です。


指摘
16 一文に二回以上利用されている助詞 “や” がみつかりました

EPUB形式はパソコンやタブレットや電子書籍端末で電子書籍を見ることができます。


指摘
17 漢字が7つ以上連続しています:電子書籍専用端末

電子書籍専用端末には、KindleやKoboなどがあります。

漢字同士が連続していると読みにくくなるので、連続できる最大の漢字長は6文字までに制限しています。

6行目の「電子書籍端末」はエラーではありませんが、「電子書籍専用端末」はエラーになります。


指摘
20 文中に逆接の接続助詞 “が” が二回以上使われています

Re:VIEWは素晴らしいツールですが、
Windowsへのインストールが難しいと言われていましたが、
2018年現在は簡単にインストールできます。

「○○ですが、□□いましたが、△△できます」という問題のある日本語です。


指摘
26 同じ接続詞が連続して使われています

Re:VIEWは素晴らしいツールです。
しかし、Windowsへのインストールが難しいと言われていました。
しかし、2018年現在は簡単にインストールできます。

「○○です。しかし、□□いました。しかし、△△できます」という問題のある日本語です。


指摘
28 “することができます”は冗長な表現です

Re:VIEWは素晴らしいツールです。技術用の電子書籍を簡単に作成することができます。

ルールの設定方法

.textlintrcのファイル構成は、Configuration Filesに説明があります。

ルール名とパッケージ

ルール名<name>を組み込むには、パッケージ「textlint-rule-<name>」をインストールします。
そして、.textlintrcファイルで有効化します。

技術文書向けルールプリセット(textlint-rule-preset-ja-technical-writing)を有効化する例を示します。

ルールの有効/無効

「ルール名」が有効(true)か、無効(false)か、個別指定(object)かを定義します。

具体的には、次のようになります。

  • ルールA : 有効
  • ルールB : 無効
  • ルールC : 有効にして、{ “キー” : “設定値” }をルールに渡す

ルールプリセット

ルールプリセットは、ルールをまとめたものです。

ルールプリセット(preset-ja-technical-writing)のja-no-weak-phraseルールを無効にする例を示します。

ルールのカスタマイズ

技術文書向けルールプリセット(textlint-rule-preset-ja-technical-writing)をカスタマイズした.textlintrcを示します。

サンプル原稿の再チェック

技術文書向けルールプリセット(textlint-rule-preset-ja-technical-writing)のルールをカスタマイズした.textlintrcで、サンプル原稿をチェックします。

textlint 指摘

textlint 指摘



9行目の「Disallow to use “?”」の指摘が消えて、10行目の「Disallow to use “!”」は指摘されました。

カスタマイズしたルールで、全角の”?”の使用を有効にしています。


17行目の「漢字が6つ以上連続しています: 電子書籍専用端末」という指摘があります。

カスタマイズしたルールでは、連続する漢字長を5文字に制限していますので、「電子書籍端末」と「電子書籍専用端末」は指摘対象です。しかし、例外としてallowで”電子書籍端末”を指摘しないように設定しました。

まとめ

Windows10にtextlint校正ツールをインストールして、Re:VIEW日本語原稿をチェックできました。
日本語で記述した技術文書向けルールをインストールしてルールをカスタマイズし、適切に日本語チェックが行えました。