忍者ブログ

[PR]

×

[PR]上記の広告は3ヶ月以上新規記事投稿のないブログに表示されています。新しい記事を書く事で広告が消えます。

最低限度文化的なドキュメントジェネレータとは?

YOUsuke 曰く、何本か技術的なドキュメントを書きたいんだが、良いジェネレータが見つからない。一つのリソースからHTMLとPDFを生成したいそうらしいです。体裁としてはAppleの開発ドキュメントのようなものを想定している(例 Core Data Programming Guide)。frameなどで章を行き来できることが最低条件である(伝統的なprevious, next, topナビゲーションからは脱却したい)。 将来的な共同作業を考えるとクロスプラットフォームなツールが望ましい。また副次的な要求であるがバージョン管理を考えるとリソースはテキストである方が扱いやすいだろう。すぐに思い浮かぶのがtexとWikiであるが、texは強力ではあるが日本語環境構築が私家版に頼りすぎている(というか私家版しかない)ので好みではない。Wikiは掲示板機能などのライブな情報蓄積が魅力ではあるが、章構成に弱いことが不満である。PDFの生成ができるWikiについては未調査である。 テキストでないリソースとしてはOpenOfficeがPDFとHTMLを作成でき、またPDFの作成では見出しからしおりを生成してくれるので好印象ではある。しかし、生成されるHTMLは単一ページであり章を行き来するのが面倒であることが不満である。 ソースコードからドキュメントを生成するツールについてはjavadocやdoxygenなど豊富であるが、ソースを元としない、技術解説に適したツールにはどのようなものがあるでしょうか? すべて読むSlashdotに聞けセクション書籍 関連ストーリー: すべてのプログラマは英語を理解するべきなのか? 2009年04月03日 ドキュメント類の保護管理はどうすべきか? 2008年12月26日 Python 2.5 の公式ドキュメント日本語訳完成 2008年10月24日 PFU、Webブラウザ上で「ページがめくれる」文書公開ツール発表 2006年10月16日 2009年04月27日

これは急がないと!
PR