From: ajay paswan <lists@...>
Date: 2012-10-04T17:06:44+09:00
Subject: Re: Writing developer's document and user's document

Jam Bees wrote in post #1078558:
> Developer docs are probably best written as rdoc inside the code. Check
> the standard library docs for array for a solid example.
Do I need anything apart from RDoc?
> User doc, what's your audience? Sys admins, end users etc. that informs
> the rest.
Audience is end users, say layman.

> The software you use to put it together doesn't really matter as long as
> it is well written.
What does it mean by 'well written'.

Anything like Rdoc for writing user_doc?

-- 
Posted via http://www.ruby-forum.com/.