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

Confluenceで納品用ドキュメントを作成する

最近、JIRAと一緒にインストールしたConfluenceをさわっているのですが、細かいところまで作りこまれていて感心させられます。正直、オープンソースプロジェクトのサイトで使われているのを閲覧している限りは、それほどよい印象はなかったのですが...。

特にwikiのデータをPDFやHTMLにエクスポートする機能がよいです。Atlassianの製品のドキュメントはConfluenceで作成されているようで、Confluence自体ののPDF形式のドキュメントは↓から見ることができますが、
Confluence Documentation Directory - Atlassian Documentation
受託開発やWebベースのアプリケーションの納品用ドキュメントとして使えるクオリティだと思います。

私のところではアプリケーションからの閲覧用にHTMLと印刷用にPDFのドキュメントを用意することが多いのですが、ワンソースで対応出来るように、少し前からreStructuredTextで書くようにしています。ただ、環境構築が面倒だったり、独自のマークアップに抵抗があったりで、開発者以外には難しい部分がありました。その点、ConfluenceだとWYSIWYGのエディタで入力できるので、開発者以外でもなんとかなりそうです。

また、reSTはテキストファイルなので当然、単体ではコラボレーションツールとしては使えません。また、Googleサイトは共同編集などには向いていますが、エクスポートの機能がないのでスタンドアロンのドキュメントの作成ができません。ということでConfluenceです。

AtlassianのConfluenceを見ると製品ごとバージョンごとにスペースを作っていて、スペース単位のエクスポートでPDFを作成しているように見えるので、とりあえずこれを真似してみました。ただ、実用レベルに持っていくにはPDFレイアウトやスタイルシートの設定でノウハウが必要そうです。

Editing the PDF Stylesheet - Confluence Docs 3.1 - Atlassian Documentation - Confluence

ドキュメントやフォーラムを調べればすぐできることもあると思いますが、とりあえず次のようなことです。

  • カバーページを付ける
  • セクションにナンバーを振る
  • セクションで改ページを制御する
  • PDF用CSSの書き方
  • wikiが編集されたら(もしくは定期的に)、自動でエクスポートする