From: Jam Bees <jam@...>
Date: 2012-10-04T23:12:03+09:00
Subject: Re: Writing developer's document and user's document



On 4 Oct 2012, at 02:06, ajay paswan <lists@ruby-forum.com> wrote:

> 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?

Only if you want something different. 
> 
>> 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'.

I imagine this is a translation problem. Well written for me means that there are examples of usage etc.

Well written means the documentation is informative and tells you how to actually use the software.

> 
> Anything like Rdoc for writing user_doc?

I don't know.