Documentation tools documentation

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

Documentation tools documentation

Ron Wheeler
I can not edit the Project Administration site.
Jacques has asked to have a note about Graphviz and the dot language.
I would suggest that we have a documentation tools page where we
identify the tools used to create diagrams, charts, UML models, E/R
diagrams.
This could be a single page with very short descriptions and links to
the download pages, documentation and tutorials and showcases for each
tool that we want people to use to create documentation.

It could also include contact information for volunteerss who are
willing to help others create new visual artifacts (I will help anyone
who wants to create a Graphviz image for the wiki.)

Ron

--
Ron Wheeler
President
Artifact Software Inc
email: [hidden email]
skype: ronaldmwheeler
phone: 866-970-2435, ext 102

Reply | Threaded
Open this post in threaded view
|

Re: Documentation tools documentation

Jacques Le Roux
Administrator
Why not rather using Gliffy that we have available in Confluence http://www.gliffy.com/user-manual/?productId=1 ?

Jacques

Le 18/12/2014 14:53, Ron Wheeler a écrit :

> I can not edit the Project Administration site.
> Jacques has asked to have a note about Graphviz and the dot language.
> I would suggest that we have a documentation tools page where we identify the tools used to create diagrams, charts, UML models, E/R diagrams.
> This could be a single page with very short descriptions and links to the download pages, documentation and tutorials and showcases for each tool
> that we want people to use to create documentation.
>
> It could also include contact information for volunteerss who are willing to help others create new visual artifacts (I will help anyone who wants
> to create a Graphviz image for the wiki.)
>
> Ron
>
Reply | Threaded
Open this post in threaded view
|

Re: Documentation tools documentation

Jacques Le Roux
Administrator
So everyone is happy with an external tool when we have an internal dedicated tool for that?

Jacques

Le 19/12/2014 22:00, Jacques Le Roux a écrit :

> Why not rather using Gliffy that we have available in Confluence http://www.gliffy.com/user-manual/?productId=1 ?
>
> Jacques
>
> Le 18/12/2014 14:53, Ron Wheeler a écrit :
>> I can not edit the Project Administration site.
>> Jacques has asked to have a note about Graphviz and the dot language.
>> I would suggest that we have a documentation tools page where we identify the tools used to create diagrams, charts, UML models, E/R diagrams.
>> This could be a single page with very short descriptions and links to the download pages, documentation and tutorials and showcases for each tool
>> that we want people to use to create documentation.
>>
>> It could also include contact information for volunteerss who are willing to help others create new visual artifacts (I will help anyone who wants
>> to create a Graphviz image for the wiki.)
>>
>> Ron
>>
>
Reply | Threaded
Open this post in threaded view
|

Re: Documentation tools documentation

Sharan-F
Hi Jacques

I think that if we already have an internal dedicated tool that we can use for diagrams etc then it would be good to use it.

The issue that we had (and still have) is that some of the diagrams were made using software that we dont have access to anymore so cant update them. We didnt know about the internal tool and as a result  Ron suggested some possible open source tools we could use and updated a diagram using one of them.

I will update the documentation roadmap to say that we recommend using the internal tool.

Thanks
Sharan



Reply | Threaded
Open this post in threaded view
|

Re: Documentation tools documentation

Jacques Le Roux
Administrator
Yes I know that Shara thanks, if I get enough time I will re-create with Giffy, I was hoping Ron could ;)

Jacques

Le 08/01/2015 09:55, Sharan-F a écrit :

> Hi Jacques
>
> I think that if we already have an internal dedicated tool that we can use
> for diagrams etc then it would be good to use it.
>
> The issue that we had (and still have) is that some of the diagrams were
> made using software that we dont have access to anymore so cant update them.
> We didnt know about the internal tool and as a result  Ron suggested some
> possible open source tools we could use and updated a diagram using one of
> them.
>
> I will update the documentation roadmap to say that we recommend using the
> internal tool.
>
> Thanks
> Sharan
>
>
>
>
>
>
>
> --
> View this message in context: http://ofbiz.135035.n4.nabble.com/Documentation-tools-documentation-tp4659862p4660987.html
> Sent from the OFBiz - Dev mailing list archive at Nabble.com.
>
Reply | Threaded
Open this post in threaded view
|

Re: Documentation tools documentation

Ron Wheeler
In reply to this post by Sharan-F
I am willing to look at converting to the internal tool, if there is
some documentation on it and I can find a way to use it.

How do I get started?

Ron

On 08/01/2015 3:55 AM, Sharan-F wrote:

> Hi Jacques
>
> I think that if we already have an internal dedicated tool that we can use
> for diagrams etc then it would be good to use it.
>
> The issue that we had (and still have) is that some of the diagrams were
> made using software that we dont have access to anymore so cant update them.
> We didnt know about the internal tool and as a result  Ron suggested some
> possible open source tools we could use and updated a diagram using one of
> them.
>
> I will update the documentation roadmap to say that we recommend using the
> internal tool.
>
> Thanks
> Sharan
>
>
>
>
>
>
>
> --
> View this message in context: http://ofbiz.135035.n4.nabble.com/Documentation-tools-documentation-tp4659862p4660987.html
> Sent from the OFBiz - Dev mailing list archive at Nabble.com.
>


--
Ron Wheeler
President
Artifact Software Inc
email: [hidden email]
skype: ronaldmwheeler
phone: 866-970-2435, ext 102

Reply | Threaded
Open this post in threaded view
|

Re: Documentation tools documentation

Ron Wheeler
In reply to this post by Jacques Le Roux
Is this Gliffy http://www.gliffy.com/products/confluence-plugin/ rather
than Giffy.

Ron

On 08/01/2015 4:14 AM, Jacques Le Roux wrote:

> Yes I know that Shara thanks, if I get enough time I will re-create
> with Giffy, I was hoping Ron could ;)
>
> Jacques
>
> Le 08/01/2015 09:55, Sharan-F a écrit :
>> Hi Jacques
>>
>> I think that if we already have an internal dedicated tool that we
>> can use
>> for diagrams etc then it would be good to use it.
>>
>> The issue that we had (and still have) is that some of the diagrams were
>> made using software that we dont have access to anymore so cant
>> update them.
>> We didnt know about the internal tool and as a result  Ron suggested
>> some
>> possible open source tools we could use and updated a diagram using
>> one of
>> them.
>>
>> I will update the documentation roadmap to say that we recommend
>> using the
>> internal tool.
>>
>> Thanks
>> Sharan
>>
>>
>>
>>
>>
>>
>>
>> --
>> View this message in context:
>> http://ofbiz.135035.n4.nabble.com/Documentation-tools-documentation-tp4659862p4660987.html
>> Sent from the OFBiz - Dev mailing list archive at Nabble.com.
>>
>


--
Ron Wheeler
President
Artifact Software Inc
email: [hidden email]
skype: ronaldmwheeler
phone: 866-970-2435, ext 102

Reply | Threaded
Open this post in threaded view
|

Re: Documentation tools documentation

Jacques Le Roux
Administrator
In reply to this post by Ron Wheeler
I put a link into my 1st message in this thread http://markmail.org/message/kjwmvlqscztbsxv2

Jacques

Le 08/01/2015 15:59, Ron Wheeler a écrit :

> I am willing to look at converting to the internal tool, if there is some documentation on it and I can find a way to use it.
>
> How do I get started?
>
> Ron
>
> On 08/01/2015 3:55 AM, Sharan-F wrote:
>> Hi Jacques
>>
>> I think that if we already have an internal dedicated tool that we can use
>> for diagrams etc then it would be good to use it.
>>
>> The issue that we had (and still have) is that some of the diagrams were
>> made using software that we dont have access to anymore so cant update them.
>> We didnt know about the internal tool and as a result  Ron suggested some
>> possible open source tools we could use and updated a diagram using one of
>> them.
>>
>> I will update the documentation roadmap to say that we recommend using the
>> internal tool.
>>
>> Thanks
>> Sharan
>>
>>
>>
>>
>>
>>
>>
>> --
>> View this message in context: http://ofbiz.135035.n4.nabble.com/Documentation-tools-documentation-tp4659862p4660987.html
>> Sent from the OFBiz - Dev mailing list archive at Nabble.com.
>>
>
>