Download as PDF, PPTX
Uploaded bymoonmaster9000
PDF, PPTX635 views
Readme driven development
This document discusses documentation strategies for open source projects, suggesting a three act structure for README files with an introductory hook, tutorial section, and brief conclusion. It also mentions different documentation generation tools like RDoc, YARD, and wiki pages while clarifying that a README is not a replacement for full documentation.
More Related Content
Recently uploaded
Readme driven development
- 1.
- 2.
- 3.
- 5.
- 6.
- 7. README is not documentation
- 8.
- 9.
- 10.
- 11.
- 12.
- 13. ACT 3 get outquickly
- 14.
- 15.
- 16. emergent design != design
- 17.
- 18.
- 19.
- 20.