From aa1b9037bf609d11ed0a2a4d5f2028c66ffc2351 Mon Sep 17 00:00:00 2001 From: Steve Klabnik <steve@steveklabnik.com> Date: Fri, 7 Dec 2012 23:31:17 -0800 Subject: Fill out API Documentation Guidelines 'you will learn' list. --- guides/source/api_documentation_guidelines.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'guides/source') diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index 0126fc94d1..5c4aae8900 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -5,6 +5,10 @@ This guide documents the Ruby on Rails API documentation guidelines. After reading this guide, you will know: +* What RDoc is. +* How to write effective prose for documentation purposes. +* Style guidlines for documenting different kinds of Ruby code. + -------------------------------------------------------------------------------- RDoc -- cgit v1.2.3