アジャイルExcel-ノウハウ (X) Markdownとの役割分担

2021年12月2日

Markdownは以下のようなメリットがあり、特にUNIX系の開発者に愛好家が多いのは理解できる。

  • テキストであることから、ソースコード編集の一環としてカジュアルに更新が可能
  • そこそこ表現力のある文書作成が可能
  • テキストであることから、gitなどのVCSでの履歴管理と親和性が高い
  • 直感的で簡素な記法であることから教育コストが低い
  • デファクトスタンダードとなっており、エディタのMarkdownモードなどツールのサポートが充実

しかし簡略化されているとはいえ、結局はHTMLを直書きしているのと等価である。文書としての複雑さが高まるにつれ編集の手間が急増する。そうなってくると、手段が目的化してしまう危険性がある。ツールのインストールや自作などの環境改善、そして複雑化した文書のデバッグに時間を費やしてしまうというのは、よく見る光景だ。

そのような事態を防ぐためには、Excelなど他の文書作成ツールで作成した文書との役割分担と相互参照が重要となる。典型的なのは、詳細設計以降の頻繁な変更が予想される部分や、ユーティリティ的なツールのドキュメントはMarkdownを使うというものだろう。もちろん上位文書との用語などの統一が必要なのは言うまでもない。

Posted by urojima