自分の原稿のスタイルに合わせたtextlintルールを公開しました

次の本の原稿を書いています。その原稿の誤字脱字や表現のチェックを機械的に行うためにいろいろなサービスを契約し、試してきました。しかし、完全に満足できるサービスが見つかりませんでした。

そこで、textlintを使ってチェックするように設定し、独自の校正辞書を作ることにしました。書きながら更新している辞書ですが、GitHubで公開しました。ライセンスはMITです。

完全にゼロから作った辞書ではありません。ics.mediaさんがMITライセンスで公開している `textlint-rule-preset-icsmedia` をフォークしました。

目次

作ることにした理由

完全に満足できるものがないなら、作るしかない。つまり、既存のルールではカバーしきれない部分があり、それを解決するために独自ルールを作ることにしました。

テクニカルコミュニケーター協会さんの「日本語スタイルガイド(第3版)」を参考に自分の文章を見直しました。「外来語(カタカナ)表記のガイドライン」とics.mediaさんの textlint-rule-preset-icsmedia の指摘内容に沿って表記を直しました。

その結果、AppleのmacOSの日本語版での表記と合わない部分が出てきました。たとえば、「フォルダ」は、Appleは「フォルダ」、日本語スタイルガイドやics.mediaさんのルールでは「フォルダー」となります。最後に長音記号を付けるかどうかが異なります。

他にも数カ所ありました。自分が書いているのはmacOSアプリの開発方法の解説書です。手順説明では画面に表示されている表記をそのまま使用する必要があります。そのままでは、2つの表記が混在することになります。それは良くないのでどちらかに統一しようとすると、textlintのルールを変更する必要があります。

そこで、ics.mediaさんのリポジトリをフォークして、それらの部分を変更することにしました。

「まだ」というよりも「ずっと」更新中

原稿を書きながら気づいたものを追加していくので、まだ、というよりも、ずっと更新中です。フレームワークの名前やプログラム名、固有名詞などを、表記揺れするたびに追加します。

著書紹介

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

Akira Hayashi (林 晃)のアバター Akira Hayashi (林 晃) Representative(代表), Software Engineer(ソフトウェアエンジニア)

アールケー開発代表。Appleプラットフォーム向けの開発を専門としているソフトウェアエンジニア。ソフトウェアの受託開発、技術書執筆、技術指導・セミナー講師。note, Medium, LinkedIn
-
Representative of RK Kaihatsu. Software Engineer Specializing in Development for the Apple Platform. Specializing in contract software development, technical writing, and serving as a tech workshop lecturer. note, Medium, LinkedIn

目次