いい加減、そのソースのドキュメント管理はReadmeでした方がいい - Qiita
表題の通り、かつ今更感パネエなのですが、その理由を書きます。 この記事で伝えたいことを一行で プログラムの仕様はReadmeに書いてソースと一緒に管理したら良いこといっぱいあるよってこと 予備知識 Readmeの書き方やREADME駆動開発については、他の方が書いていただいた、以下の記事がとても参考になると思います。 わかりやすい README 駆動開発 reStructedTextの記法については、以下のドキュメントが大変、参考になります。 reStructuredText入門 Markdownの記法については、以下の記事が大変、参考になります。 Markdown記法 チートシート 質問 ところで、Readme書いてますか？ reStructedText形式やMarkdown形式などで書ける以下のようなやつです。 ドキュメント更新はずっと課題 ドキュメントというものの保守コストは非常に高
読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
