ITエンジニア/デザイナ向けにオープンソースを毎日紹介

プログラマのためのドキュメントと言えば、JavaDocやRDoc、PHPDocなどが有名だ。これらはソース上にコメントとして書けるので、実際のコーディングとドキュメントとが乖離するのを防ぐことができる。


ピクチャ 263.png

RDocを閲覧できる

 

だがそれらのドキュメントをいちいち生成していたのでは面倒だ。編集の手間も軽減するこれを使ってみよう。

今回紹介するオープンソース・ソフトウェアはDocBox、RDocコラボレーションソフトウェアだ。

DocBoxはRDocをまるでWikiのように扱うことができるソフトウェアだ。ソースコードをDocBoxにインポートして動作する。ドキュメントはWikiのようにWebベースで編集が可能だ。


ピクチャ 264.png

Web上で編集できる

 

編集した内容は元のソースコードへの反映したり、Gitリポジトリのドキュメントブランチへのコミットができるとのこと。*.rbファイルや、READMEファイルが対象になるので、定期的にインポートしていけば便利なドキュメントビューワーになるはずだ。

開発用ドキュメントが整備されない理由の第一は、閲覧したり利用したりする回数が少ないことが挙げられる。DocBoxを使えばWebベースで閲覧、コラボレートするようになって利用度が上がるはずだ。

 

iownbey's docbox at master — GitHub

 http://github.com/iownbey/docbox/tree/master

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2