文書のレビューツール

[azu]

textlintなどは校正ツールでこれは自動テストできる。
一方、レビューは考えたり別の表現の提案といったフェーズになるので推敲を補助するツールが必要。
推敲ツールは提案なので自動テストできない(false-positiveになるかもしれないため)

• 校正支援と推敲支援 | 技術文書をソフトウェア開発する話

レビューツールは色々なものがありそうだけど、目的としているのは違和感をあぶり出して問題を見つけやすくする補助ツール。
またはMarkdownなどソースに対してレンダリングして結果をプレビューして、問題を見つけるもの。

類似

• nakajmg/cgmd-browser: Realtime preview for codegrid-markdown
• 小説推敲補助ソフト「Novel Supporter」 - クロノス・クラウン -
• Tomarigi（校正・推敲支援ツール） | PaWeL：日本語表現法開発プロジェクト-青山学院大学-

目的ではないもの

• 管理するツール
• ワークフロー
• 単体で動かないもの
• ウェブサービス

[azu]

urnote/urnote: Markdown notes review tool

対話的なチェック方式の補助ツール

[azu]

手元でつくってみてるもの。
textlintのmessageを渡してエディタ的に表示できるツール。
汎用的にアノテーション情報を渡してテキストとハイライトとかを混ぜて表示するイメージ。

[azu]

azu/markdown-review-tool: Markdown review tool
以前作ったレビュー向けのツール。
GitHubにコメントを書く向けのアノテーションをする

[azu]

最終的に欲しいものはある機能じゃなくて、ある機能を追加することでできるものが欲しい

[azu]

考え方的には2つ方向がありそう

• 別のツールの結果を表示するツール
  • アノテーションデータを受け取って表示
• ソースを表示してアノテーションを行うツール
  • レビューしたい結果を書き込んだりメモしたりするツール

[azu]

音声で読み上げながらミスを見つけるツールも便利そう。

[azu]

k16's note: 技術書のレビューの経験則

[azu]

azu/vscode-read-aloud-text: VSCode extension that read aloud text like Markdown and text etc...
作った

[azu]

VSCodeのGitHub連携がIssue作ってレビュータイプとしても悪くない感じ。