Blog Top:

文章のトンマナを textlint に任せる

秦 友幸
エンジニア

これはNota Advent Calendar 2021 の10日目の記事です。
こんにちは、Helpfeel エンジニアの hata6502 です。日々 Nota のプロダクトに関わりながら、趣味でも元気に*1 開発をしています。そのなかから、textlint を使った文章校正について紹介したいと思います。

TL;DR

文章の細かいトンマナは textlint に任せられる。来年の抱負、もっと Helpfeel を使っていきたい。

textlint とは

textlint

The pluggable linting tool for text and markdown.
textlint is similar to ESLint, but it's for use with natural language.

azu氏が開発されている文章校正ツールです。様々なプラグインをインストールしてカスタマイズできます。

文章のトンマナを textlint に任せる

日本語の文法的なトンマナを合わせることができます。

話し言葉を発見できる

<ら抜き言葉>

<い抜き言葉>

読みづらい表現を発見できる

<連続で同じ助詞を使っている箇所>

  • textlint-rule-no-doubled-joshi
  • 「〜で〜で」という表現(「私のほうでツールで対処しますね」→「私のほうでツールを使って対処しますね」)

<「〜することができる」といった冗長な表現>

表記ゆれを発見できることがある

スペースの入れ方を統一できる

  • 「English sentence と日本語の間のスペース」など。

常用漢字や人名用漢字から外れた漢字を発見できる

上記で挙げた例のほかにも、お好みで textlint rule を入れて文章校正できます。

Collection of textlint rule · textlint/textlint Wiki · GitHub

もっと Helpfeel を使っていきたい

ここまで textlint の紹介をしてきましたが、私自身はまだ文章を書くコツを知っているとは思いません。文章のトンマナを揃えることはできても、読みやすい内容の文章を書くには別のスキルが必要かなと考えています。来年からはヘルプサイトとしての文章執筆を知ること*2が、開発のアイデアを思いつくうえでも重要そうです。

Nota では、Helpfeel に限らず、Scrapbox や Gyazo のプロダクトをまたいだアイデア共有も積極的に行われています!全職種にて採用を行っていますので、興味がある方は、ぜひ採用サイトを確認してみてください。

採用サイト: https://notainc.com/ja/recruit

明日の Nota Advent Calendar 2021 では、村川さん (@shmpmrkw) が Helpfeel のセールスやマーケティングについて語ってくれるようです。
お楽しみに。

*1 : 元気なので、休日でも勝手に便利ツール作ったりしています。

*2 : テクニカルライティングの本を買った。アドベントカレンダーで宣言しちゃえば、きっと勉強し始めるはず。

We are hiring

Notaではサービスの急成長に伴い新しい仲間を必要としています

More from the Blog