Free Preview: Documentation in Ruby

What, When, Where And Why To Document

10:47

What, When, Where And Why To Document

Before jumping into the Terminal as usual, it’s important to acknowledge and understand the principles behind documentation. It exists for the fundamental purpose of helping people embrace your product better and faster.

You are just one of the many actors in your project. Besides other people who think differently from you, your future self will have second thoughts about what you write today. Documentation consolidates and promotes your product’s success, both in the present and the future.

1.Introduction
3 lessons, 20:03

Free Preview
1.1
Introduction
03:09

Free Preview
1.2
What, When, Where And Why To Document
10:47

1.3
Readme Driven Development
06:07

2.RDoc
4 lessons, 44:51

2.1
RDoc Introduction and Bootstrap
08:47

2.2
The Rdoc Syntax
10:41

2.3
Directives
14:51

2.4
Generating Documentation With Rake
10:32

3.Yard
3 lessons, 29:29

3.1
Yard Introduction and Bootstrap
05:43

3.2
Tags
15:42

3.3
Extended Markup
08:04

4.Tomdoc
2 lessons, 16:51

4.1
Tomdoc Introduction
11:23

4.2
Integration with RDoc and Yard
05:28

5.Conclusion
1 lesson, 04:28

5.1
Final Tips
04:28


About José Mota
I'm a Rubyist/Javascripter/UI designer; occasional speaker; Mac & Arch Linux user.
+ Expand Bio- Collapse Bio