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

DocsDoctorのコンセプトはかなり刺激的です。「良いプログラマーはドキュメントを読む。優れたプログラマーはドキュメントを書く」…どうでしょう、格好良いですよね。

ということでDocsDoctorはオープンソースのプロジェクトに対してドキュメントがない部分を洗い出し、参加を促します。ドキュメントが充実すればプロジェクト全体の品質も高まることでしょう。

DocsDoctorの使い方

こちらはトップページ。
こちらはトップページ。

Railsであってもドキュメントがないメソッドはたくさんあります。
Railsであってもドキュメントがないメソッドはたくさんあります。

例えばこのメソッド。参加の仕方、編集の仕方も書かれています。
例えばこのメソッド。参加の仕方、編集の仕方も書かれています。

該当コード部分にジャンプもできます。
該当コード部分にジャンプもできます。

DocsDoctorはAPIドキュメントを書くシステムになります。そのためメソッドの上にJavaDocやRDocなどの形式で書くようになるでしょう。小さなメソッドだから…と放っておくとDocsDoctorが見つけてくれるはずです。社内で使っているシステムであっても役立つ存在になりそうです。

DocsDoctorはRuby/Ruby on Rails製のソフトウェア(ソースコードは公開されていますがライセンスは明記されていません)です。

DocsDoctor.org

codetriage/docs_doctor

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2