BLOGTIMES
2019/11/23

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

  opensource 
このエントリーをはてなブックマークに追加

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

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

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

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

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


    トラックバックについて
    Trackback URL:
    お気軽にどうぞ。トラックバック前にポリシーをお読みください。[policy]
    このエントリへのTrackbackにはこのURLが必要です→https://blog.cles.jp/item/11372
    Trackbacks
    このエントリにトラックバックはありません
    Comments
    愛のあるツッコミをお気軽にどうぞ。[policy]
    古いエントリについてはコメント制御しているため、即時に反映されないことがあります。
    コメントはありません
    Comments Form

    OpenID を使ってログインすることができます。

    Identity URL: Yahoo! JAPAN IDでログイン