執筆支援・ライター向け情報 - doc-wiki-jp/wiki GitHub Wiki
校正支援
- RedPen
- Javaベース
- XMLファイル (
redpen-conf.xml) に設定を書く
- XMLファイル (
- 文書執筆の指南書で解説されている問題点を RedPen で発見する - Qiita
- 書籍
- Javaベース
- textlint
- JavaScriptベース
- JSONファイル (
.textlintrc) に設定を書く
- JSONファイル (
- ルールをプラグイン (npm/yarnのパッケージ) の形で追加できる
- ディレクトリごとにプラグインをインストールするのを推奨
- グローバルのnpmを汚さず済む
- ディレクトリごとにプラグインをインストールするのを推奨
- エラーメッセージが日本語で分かりやすい
- プラグイン・プリセット一覧
- Collection of textlint rule · textlint/textlint Wiki
- textlint-ja/textlint-rule-preset-japanese
- 技術文書で利用するためのルール集
- 入れても誤爆が少ないルールに限定する
- スタイル(スペースの有無など)に関連するルールは含めない
- textlint-ja/textlint-rule-preset-ja-technical-writing
- 技術文書向けのtextlintルールプリセット
- azu/textlint-rule-preset-JTF-style
- JTF日本語標準スタイルガイドに準拠
- azu/textlint-rule-spellcheck-tech-word
- 技術用語の表記ぶれを整える
- 文書執筆の指南書で解説されている問題点を textlint で発見する - Qiita
- JavaScriptベース
ドキュメントの継続的インテグレーション(CI)
- ドキュメントの継続的な開発方法 | IIJ Engineers Blog
- ドキュメント作成ツール: Sphinx
- パッケージ管理: pip + virtualenv
- Git + GitHub
- CIツール: Drone
- 校正ツール: textlint
- プラグイン: textlint-plugin-rst
- ドキュメント作成ツール: Sphinx
- textlintで日本語の自動校正サービスを作ってみた！ | それいけ！フロントエンド