91
µTasker general / Re: uTasker Documentation
« on: April 30, 2010, 10:48:36 AM »
Hi Mark,
I understand the problems of trying to juggle product documentation against product development.
One of the tools we use for documentation is "Help and Manual" http://www.ec-software.com/ this allows us to product PDF, CHM and HTML help from one source. Not cheap but very good. Another product that may also do a similar job is "Infohesive" http://www.2brightsparks.com/infohesive/features.html I have not tried this product but it looks interesting, and its a lot cheaper than help and manual.
I'm also trying to think if there is anyway some of us as users can help with the documentation effort, maybe some form of wiki. Where we can post code snippets etc. and fill in a documentation template that you have setup (function documentation for instance). You can just moderate / correct what we do, and also provide style guidelines. Again there is the extra issue of copying data out of the wiki and into other forms of offline help (PDF/CHM).
You need a combination wiki/Goggledocs type service which can save in an offline format (PDF and CHM), where the wiki can be browsed and searched in a read only mode by users but also edited by selected users. It would obviously need to be multi user allowing concurrent updates at the same time. Its a holy grail but I'm not sure what the solution is.
Cheers
Martin
I understand the problems of trying to juggle product documentation against product development.
One of the tools we use for documentation is "Help and Manual" http://www.ec-software.com/ this allows us to product PDF, CHM and HTML help from one source. Not cheap but very good. Another product that may also do a similar job is "Infohesive" http://www.2brightsparks.com/infohesive/features.html I have not tried this product but it looks interesting, and its a lot cheaper than help and manual.
I'm also trying to think if there is anyway some of us as users can help with the documentation effort, maybe some form of wiki. Where we can post code snippets etc. and fill in a documentation template that you have setup (function documentation for instance). You can just moderate / correct what we do, and also provide style guidelines. Again there is the extra issue of copying data out of the wiki and into other forms of offline help (PDF/CHM).
You need a combination wiki/Goggledocs type service which can save in an offline format (PDF and CHM), where the wiki can be browsed and searched in a read only mode by users but also edited by selected users. It would obviously need to be multi user allowing concurrent updates at the same time. Its a holy grail but I'm not sure what the solution is.
Cheers
Martin