Documentation in Ruby

with

Part of Ruby’s growth lies in its community and its willingness to provide the absolute best tools for solving problems. If a tool is not well documented, there’s a strong chance that it might not be used. This course is designed to teach you about the importance of documentation and its impact on code, people, and business. Specifically, we’ll focus on three tools: RDoc, Yard and Tomdoc. Let’s get started!

1× speed

Free Preview: Documentation in Ruby

Introduction

03:09

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


Preview for Documentation in Ruby
Lessons:
13
Length:
1.9 hours
I'm a Rubyist/Javascripter/UI designer; occasional speaker; Mac & Arch Linux user.
+ Expand Bio- Collapse Bio