皆さんこんにちは! Technology & Design DepartmentのDEVチーム所属の定吉です。
広報業務も担当してから記事を書く機会が増えました。ブレインストーミングから草稿やドキュメントチェックなど、一連のフローを通じて記事を公開するまでの労力って結構かかります。
特にドキュメントチェックは、単純な文字の誤りや表現を見るだけでなく、コンテンツ内容まで踏み込んで徹底した事実確認を行います。
そのため、「単純な文字の誤りや表現」をなくす作業はより正確かつスムーズに進めたい!そんな思いから、textlintという文章校正ツールを使い、ドキュメントチェックに取り入れてみました。
textlint とは
textlintは、文章を書く場合の誤字脱字や読みづらい表現などを検知し、知らせてくれる校正ツールのことです。
例えば、「確かにそういったケースはない事はない。」や「それが事の発端だったといえなくもない。」など、「〜ないことはない」「〜なくもない」という二重否定。このような読みづらい表現をtextlintは検知し、テキストで教えてくれます。
textlintを使ってみる
では実際にtextlintの環境構築をしてみましょう。
(1)textlintの導入
npmを使ってtextlintをインストールします。
$ npm install textlint
インストール後、ディレクトリ下に.textlintrc
ファイルを作成します。
これでtextlintの導入自体は完了です。
あとは、どんな校正ルールを入れるかを選びます。
(2)使用する校正ルールを選ぶ
ここからは、校正ルールを選びます。 今回は、textlint-ja という日本語関係のルールを扱うリポジトリを集約したところから 使用したい条件があるリポジトリを選んで導入します。
今回は、試しに先述した二重否定をチェックするため、下記を使います。
はじめに、二重否定ルールを導入します。
$ npm install textlint-rule-no-double-negative-ja
導入後、.textlintrc
ファイルで下記を記載します。
{ "rules": { "no-double-negative-ja": true } }
記載後、文章を記入するファイルを作成します。私はdocsフォルダの中にsample.mdファイルを置きました。
├── docs │ └── sample.md ├── node_modules ├── .textlintrc ├── package-lock.json ├── package.json
sample.mdに下記例文を書いてみます。
確かにそういったケースはない事はない。
例文記載後、textlint docs/sample.md
コマンドでtextlintを実行します
$ textlint docs/sample.md /Users/----/text_lint/docs/sample.md 1:17 error 二重否定: 〜ないことはない no-double-negative-ja ✖ 1 problem (1 error, 0 warnings)
二重否定の部分が検知されました。 上記がtextlintを導入し、校正を行うまでのフローです。 どこの行が検知されたか分かるので、業務でも使えそうです。
執筆経験から必要だと思ったルールを紹介
校正ルールは他にもたくさんあります。 二重否定を検知するルールを例に、textlintの設定方法が分かったので、 執筆時に使用したいルールを幾つか紹介します。
textlintリポジトリの紹介
① 「文中に同じ助詞が連続して出てくるのをチェックするルール
執筆時につい没頭してしまうと、同じ助詞を連続して使ってしまう時がありました。
連続しても文章として成立するケースはありますが、読み辛くなることが多いです。
広報業務を始めて間もない頃、執筆時に先輩から「助詞が続くと読みづらいよね〜」と指摘頂いたことから、
その後の執筆では意識して書くようになりました。セルフチェックでも注意する重要項目の一つだったので、
嬉しいルールです。
ex)材料不足で代替素材で製品を作った。
3:10 error 一文に二回以上利用されている助詞 "で" がみつかりました。 no-doubled-joshi ✖ 1 problem (1 error, 0 warnings)
「であると言えます」など冗長的な表現を書いてしまいませんか?私はついつい書いてしまいます。 本当は「である」や「と言えます」など簡潔な表現にしたいです。そのため冗長的な表現を検知してくれるこのルールを使いたいと考えました。
3:3 error 【dict3】 "であると言えます"は冗長な表現です。"である" または "と言えます"を省き簡潔な表現にすると文章が明瞭になります。 解説: https://github.com/textlint-ja/textlint-rule-ja-no-redundant-expression#dict3 ja-no-redundant-expression ✖ 1 problem (1 error, 0 warnings)
「食べられない」を「食べれない」と書いてしまうなど、口語でよくも用いられる「ら抜き言葉」を検知してくれます。 会社としてメディアを発信する上で、ビジネスシーンでは好まれない口語を使うことはなるべく避けたいので、採用したいと考えました。
3:9 error ら抜き言葉を使用しています。 no-dropping-the-ra ✖ 1 problem (1 error, 0 warnings)
その他採用したいと考えているルールがいくつかありましたが、紹介しきれないので抜粋しました。 他にもたくさんのリポジトリがあるので、執筆時に求めているルールを探してみましょう。
さいごに
今回は文章校正ツールであるtextlintとその活用方法をご紹介致しました。
チェック基準が多く見づらい場合は、.textlintrc
ファイルでのルールを調整して使うこともできるので、
工夫して校正作業が行えます。
また文章の方向性によって採用するルールを変更できるため、
適材適所で使用できれば、「単純な文字の誤りや表現」をチェックする作業が効率化できます。
セットアップが簡単であるためエンジニアだけでなく、普段執筆やドキュメントチェックを業務でされている方にとっても、作業工数を避ける意味で非常に有益なツールになると考えているので、おすすめです!
この記事がご覧頂いた方の参考に少しでもなれば幸いです。