メインコンテンツへスキップ
ホームに戻る

ハンズオン資料づくりと textlint の試行錯誤

3

2026年になって1週間。
気づいたらまだブログを書いていなかったので、今年1本目として、軽めの技術ネタを書いてみることにしました。

最近、開発チーム向けに Claude Code のハンズオン資料を作成しています。
資料も Claude Code に協力してもらいながら進めているのですが、せっかくなので文章の品質も少し整えてみようと思い、textlint を導入してみました。

最初は textlint-rule-preset-ja-technical-writing を試しました。
文章を丁寧に整えてくれるプリセットで、とても有用だと感じています。

一方で、今回作っているのはハンズオン資料ということもあり、少し説明寄りで柔らかい表現も残したい気持ちもあります。

実際に適用してみると、表現や構造をかなり揃える方向へ寄る印象があり、目的との相性という意味では悩む部分もありました。

そこで現在は、

  • textlint-rule-preset-japanese
  • textlint-rule-preset-ai-writing

この2つを組み合わせて使い、少しずつ調整しています。

この構成にしてみて感じているのは、

  • 日本語として読みにくい部分は拾ってくれる
  • 同じ言い回しの繰り返しが減る
  • 説明口調のニュアンスはある程度残る

という、今の自分の用途にはちょうどよさそうなバランスです。

ただし、これはあくまで「自分の書き方」と「今回の資料構成」という前提があるので、ほかの文書でも同じ感想になるとは限らないと思っています。

実際に使ってみて一番悩むのは、「指摘された内容をどこまで修正するか」です。

すべて修正すると、整いすぎた文章になることがあります。
一方で、無視しすぎると lint を使う意味が薄れてしまいます。

今のところは、

  • 読み手の理解が明らかに楽になるものだけ対応する

という方針で進めています。
この考え方も、運用していく中で少しずつ変わっていきそうだなと感じています。

そんな感じで、textlint の設定については、まだ試行錯誤の途中です。文章づくりまで“開発プロセスの一部”として扱える感じが面白くて、今後も少しずつ調整しながら使っていくつもりです。

2026年も、肩の力を抜きつつ、ゆるくアウトプットしていきます。
本年もよろしくお願いします。

※ 本記事は個人の経験に基づく内容であり、特定のプリセットを推奨・否定する意図はありません。