Writing a Friendly README
A README is one of the first things people see when they find your open source project. It should be helpful, welcoming, and friendly. Posted on 14 March 2016 by Rowan Manning. Tagged with Open-Source, Writing, Documentation 87 responsesSyndicated to Twitter Your project’s README is pretty important; it’s often the first thing that a person new to your project will see, and is frequently the only
RubyDoc.info: Documenting RubyGems, Stdlib, and GitHub Projects
RubyDoc.info is your source for open source Ruby library documentation, generating fresh docs for Gems and popular Git repositories. This site uses YARD to generate docs on the fly. To make your docs look better, you can check out some of YARD's killer features. We have DISQUS integration! Click the permalink (like this one) on a method to see user comments on a method page. Looking for a GitHub p
Kazuho's Weblog: 良いソフトウェアに求められる３点セットとJSXの開発手法の改善とgit-pushdirについて
テスト駆動開発（TDD）の一般化とGitHubの登場によって、機能追加の際にコードとテストを同時に実装する（そして、両者を一括してmasterにmergeする）という開発手法が一般化してきました。 しかし、「良いプログラム」の要素を構成するのは、コードとテストのみではありません。動作するコードと、その品質を担保するためのテストがあったとしても、適切なドキュメントがなければ、ユーザーはそのプログラムをどうやって使ったら良いかわかりません。 つまり、ユーザーに使いやすいプログラムを継続的に開発／提供しようと思うと、 コード テスト ドキュメント の３点セットを提供する必要があるのです注1。 今日のJSXが抱えている最大の課題は、ドキュメントが不足しているという点にあります。その原因は、「機能追加」の際にコードとテストのみを実装してmasterにmergeすることを繰り返す一方で、ドキュメントは
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
