コンテンツ   ORDERED

DONE READMEで伝えるべき構成要素

SCHEDULED: <2021-05-09 Sun>

CLOCK: [2021-05-09 Sun 10:10]–[2021-05-09 Sun 10:19] => 0:09

READMEで伝えるべき構成要素を整理した。

要素English内部向外部向目的内容
名前Nameoo
ステータスバッジStatus Badgesoo
アイキャッチ画像Eyecatch Imagexo
概要Overviewoo
解決する問題Whyxoなぜこれが必要だったのかを説明する
他の選択肢VSxo
説明Descriptionoo
デモDemooo
機能一覧Featureoo
使い方Usageoo
必要要件Requirementsoo
インストールInstalloo
ドキュメントDocumentoo
リリースReleaseoo
バグBugoo
討議Discussionoo
プロジェクト管理Projectsoo
環境Environmentox
ライセンスLicenseoo社外秘であれば Confidential を明示する。
メンテナーMaintainerxo
謝辞Acknowledgmentsxo