2008-04-03

技術文書の管理

技術文書(ちょっとしたメモ含む)の作成から公開までのプロセスをもっと改善できないだろうか。

例えばこのサイトに載せているような記事の場合、たいていは(x)htmlを直接書くか、テキストで書いてからマークアップしている。しかし、Wiki程度の記法があれば主立った文書構造は表現できるので、これは明らかに無駄なことだ。

画像や図の扱いも頭を悩ます一因である。これは二つの理由からなる。一つはいちいち別のアプリケーションを起動しなければならない点。もう一つは別のファイルを管理しなければならなくなる点である。OLEでとっくに解決されている問題なのに、私のワークスタイルの中で未だに未解決であることは全く情けない限りである。

作成した文書をどうやってWeb上で公開するかも問題である。(x)htmlを直接書けば、ファイルをサーバーにftpでコピーするだけで良い。ange-ftpがあるので、サーバー上のファイルを直接編集したって良い。しかしこの方法はhtmlを書く段階で前述の問題がある。ローカルでいちいち変換プログラムを起動するなんてことは絶対にやりたくない。WikiのようなWebアプリを置くという手もあるが、なかなか自分にマッチするものが見つからないし、サーバー管理の手間が増す。

まとめると、

  • Wikiのような記法で書ける
  • 画像や図が簡単に挿入できる
  • 編集したファイルを無変換でサーバに置けばそれで公開
  • ブラウザ上で編集できる必要はない
  • Emacs上で編集できないと嫌

つまり、Emacs上で画像を含んだ文書を編集できるようにして、その文書をCGIかapacheの何かか、JavaScriptかなんかでhtml等に変換してクライアントに表示できれば良い訳か。