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

Developer docs are probably best written as rdoc inside the code. Check the standard library docs for array for a solid example. 

User doc, what's your audience? Sys admins, end users etc. that informs the rest. 

The software you use to put it together doesn't really matter as long as it is well written. 

On 3 Oct 2012, at 12:10, ajay paswan <lists@ruby-forum.com> wrote:

> I have developed a software using DRb, now as I have completed I want to
> write a nice complete and impressive developer document and user
> document.
> I have just started with Latex and IPE. Is there any other software to
> write it?
> 
> Am following : http://en.wikipedia.org/wiki/Software_documentation
> I am writing extensively using UML.
> Am I missing something? how to make it effective and COMPLETE?
> Is there any readymade tool like in IntelliJ IDEA which I should be
> using? Anything is there like this in rubymines? I have both IDEA and
> rubymines.
> 
> So the simple question are::
> 1. The best way to write : Latex or something else?
> 2. How to make it perfect-complete,impressive.
> 3. Any software which can help me with any part like UML?
> 4. Anything do I need to write for DRb?
> 5. Diffrence between developer's doc and user's doc? What they include?
> Please give me some pointer to get me going in the best way to write
> doc.
> 
> -- 
> Posted via http://www.ruby-forum.com/.
>