開発用ドキュメントの配置 - Qiita

​ はじめに プロジェクトのドキュメント配置について、いろいろな選択肢があると思うので整理したい。 github形式のリポジトリ そもそもなぜドキュメント配置に悩むようになったかと言えば、githubのリポジトリには直下にREADME.mdがあり、ここに概要を書いてwikiにドキュメントを充実させていくので十分なんだっけ？というところから始まる。 １つのリポジトリで完結するようなライブラリはこれでもいいと思う。wikiに画像をupできないが、<プロジェクト名>.wikiとしてチェックアウトする事で画像もコミットできるので、このやり方に慣れれば特に問題ないはず。ブラウザ上で履歴や差分も確認できる。 srcとdocは近い方がいい 元々はprojectリポジトリにdocフォルダを作成して、そこにmdファイルをアップしていた。これはこれでsrcとdocが一リポジトリで完結して収まりが良い。docの