技術文書の書き方

このノートは「可読性及び汎用性の高い技術文書」を作成するための入門を目指している。そのために必要なツールを自分の作業環境に合わせて整備するためだ。またTeXやワードで充分ではないかという質問の答えになるようにしたい。

MarkdownとかAsciidocとか聞いたことがあってもよくわかってない初心者を読者として想定するが、そもそも個人的にはじめた学習会でのノートなので、その学習会がうまく進めばここも充実すると思う(思いたい)。

もちろんHTMLで書き下してもいいが、HTML文書はレンダリングしないと可読性は低い。埋め込まれたタグが内容の理解をさまたげてしまう。エディタで書下しながら文書内容のチェックができるようなスタイルが良い。視覚から脳にすぐに訴えるようなスタイルの書き方が望ましい。技術文書では数式やコードの他に図表で直感的に表現するようなスタイルも欲しい。HTMLのテーブルのようにタグが多重化すると視覚の妨げとなってしまう。

AsciiDoc

本家のホームページ

AsciiDoc Home page と AsciiDoc入門

AsciiDoc Home page

日本語での入門ページ

Asciidoc エディタ