読者です 読者をやめる 読者になる 読者になる

明日にはでっかい太陽が昇るかもしれません。

「覚悟」とは!! 暗闇の荒野に!!進むべき道を切り開く事だッ!

エンジニアの文章管理について

コードの管理については、コンパイル時チェックや静的解析で自動的に間違いを指摘する構造がある程度と整っているが、仕事でコードを作成する前には必ず行われる設計書などの文章については、未だにWordで作成して人の目でチェックして、「です、ます。と だ、である。が混在している」などのコードの品質には影響しない部分の指摘に時間を費やすという状態から10年以上変わっていないとです。(少なくとも、私の会社では)

文章についても、コードと同じように管理できないかと思って、

  1. doxygen によるAPIリファレンスの生成を通して、コードと文章管理の一体化
  2. pandoc によるフォーマット変換で、コンテンツ作成・チェック負荷の軽減(Markdownで作成して、納品向けpdf/Wordへの自動変換。チェックはテキスト差分で確認できる)
  3. 上記作業をCIに組み込んで成果物の自動生成

を考えていたのですが、静的解析に該当する部分が穴になっていました。

最近、 RedPen: 文書チェックツール という文章の構成チェックを自動的に行えるツールについて知ったのですが、かなり期待しています。

というのも、安心の日本製なのです!

最初に上げた、「です、ます」調などの表現についての指摘が機械的に行うことができれば、当然人のレビューではコンテンツに集中することができるようになります。

まさに念願のツールです。CIにも組み込みたい。

ということで、 RedPen: 文書チェックツール を全力で応援していこうと思います。