README.md には何を書くべきか

GitHub などを使って自作のプログラムを公開するというのは、現在ではそれほど珍しいことではありません。

ただ、ちゃんとしたドキュメントがついているプロジェクトというのは残念ながら有名所を除いてあまり多くはありません。ちゃんとしたいのは山々だけど、実際のところ何を書いたら良いのか分からないという人も多いのではないかと思います。そんなときに役立ちそうな OSS ドキュメントのベストプラクティスを見つけたのでメモ。

• How to Write Good Documentation (And Its Essential Elements) - Soham

これによると以下の６つのセクションに分けて書くのがいいみたいですね。

1. Project Title
2. A Short Description
3. The Getting Started Guide
4. Tutorials
5. Sample Projects
6. API Documentation
7. Architecture Documentation

今度自分のソフトウェアを公開するときにはこの項目分けをを心がけたいと思います。