表題の通り、かつ今更感パネエなのですが、その理由を書きます。 この記事で伝えたいことを一行で プログラムの仕様はReadmeに書いてソースと一緒に管理したら良いこといっぱいあるよってこと 予備知識 Readmeの書き方やREADME駆動開発については、他の方が書いていただいた、以下の記事がとても参考になると思います。 わかりやすい README 駆動開発 reStructedTextの記法については、以下のドキュメントが大変、参考になります。 reStructuredText入門 Markdownの記法については、以下の記事が大変、参考になります。 Markdown記法 チートシート 質問 ところで、Readme書いてますか? reStructedText形式やMarkdown形式などで書ける以下のようなやつです。 ドキュメント更新はずっと課題 ドキュメントというものの保守コストは非常に高
![いい加減、そのソースのドキュメント管理はReadmeでした方がいい - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/a7943729c171756e7ccb41ddf674af552393b2e2/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9JUUzJTgxJTg0JUUzJTgxJTg0JUU1JThBJUEwJUU2JUI4JTlCJUUzJTgwJTgxJUUzJTgxJTlEJUUzJTgxJUFFJUUzJTgyJUJEJUUzJTgzJUJDJUUzJTgyJUI5JUUzJTgxJUFFJUUzJTgzJTg5JUUzJTgyJUFEJUUzJTgzJUE1JUUzJTgzJUExJUUzJTgzJUIzJUUzJTgzJTg4JUU3JUFFJUExJUU3JTkwJTg2JUUzJTgxJUFGUmVhZG1lJUUzJTgxJUE3JUUzJTgxJTk3JUUzJTgxJTlGJUU2JTk2JUI5JUUzJTgxJThDJUUzJTgxJTg0JUUzJTgxJTg0JnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmcz1iYjIzNmMxZjQwOTZmZjBkNzE0M2IyYjllZWYxMzUzZQ%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDB0MHJpdW1pJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9MzYmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz1kN2ZiYTA0ZDI4ZGQ0MWYzYWFhYjkwYzg1NTIwMDc1ZA%26blend-x%3D142%26blend-y%3D486%26blend-mode%3Dnormal%26s%3D7f2a56851588f2ffed87a057048863c5)