12
Help us understand the problem. What are the problem?

posted at

updated at

Organization

マニュアルの校正作業ツライのでVSCodeにtextlint入れた - 文章推敲ツール色々

textlint物語

上記に倣う記録。そのままですが、なぐり書き。書くのは好きだけど人の書いたものの読むだけってツライ、と思ったので入れたVSCodeとtextlint。

たすけてドラえもん

WindowsのVS Codeでtextlintを使ってリアルタイムに文章校正する。 があるよ。
Node.js / npmをインストールする(for Windows) をみてインストールします。

npm install -global textlint textlint-rule-preset-ja-technical-writing textlint-filter-rule-comments textlint-filter-rule-whitelist

打てばOK。色々ぶっ壊すと嫌なので階層を作って

C:\workspaces\textlint

main.md を配置

C:\workspaces\textlint>textlint --init
.textlintrc is created.

.textlintrc を以下のように編集

{
  "filters": {
      "comments": true
  },
    "rules": {
        "preset-ja-technical-writing": true
    }
}

textlint main.md と打ってみると、コマンド上でもエラーが見られます。

もう一息

あとは、VSCode 上から textlint のチェックを実行するために拡張機能をインストールします。
vscode-textlint - Visual Studio Marketplace

インストール後 VSCode を再起動し、作成したプロジェクトを開くことで textlint が有効になります。

Ctrl + Shift + V で、
Visual Studio Code で Markdown リアルタイムプレビュー機能を使える

Enjoy!

image.png
目視の助けくらいにはなるかも。

テキスト校正くん

同様、日本語を構成してくれるVSCode拡張

こんな感じのことを指摘してくれる。
image.png

中身的にはtextlintらしいので、textlintを自分でカスタマイズしていくか、うまく選択すると良さそう。

スタイルガイド

折角なので以下ツールについても書いておく。
JTF日本語標準スタイルガイドは、実務翻訳において和訳時に使用できる日本語表記ガイドライン。
またスタイルガイドとしてはGoogle社、マイクロソフト社のものが圧巻。

lint

textlintはMarkdownなどテキスト向けのLintツール(元の意味は主にC言語のソースコードに対し、コンパイラよりも詳細かつ厳密なチェックを行うプログラム)。

アンチパターン

仕様書・設計書・提案書・メール・障害票に「各ドキュメント共通してありがちなアンチパターン」。

技術書典12で用いた同人誌の執筆環境とGitHub Oriented Wrintingの紹介

以上お役に立てばさいわいです。

Register as a new user and use Qiita more conveniently

  1. You can follow users and tags
  2. you can stock useful information
  3. You can make editorial suggestions for articles
What you can do with signing up
12
Help us understand the problem. What are the problem?