TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:reviewer process - for HTML "doc" From:"Monique Semp" <monique -dot- semp -at- earthlink -dot- net> To:"TechWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 22 May 2014 14:56:44 -0700
Iâm using Doxygen to generate HTML output for a C++ library. Not all the doc reviewers have direct access to the code that Iâm commenting, so Iâll need to solicit reviews by using the HTML output instead of just having the engineers look at my code check-ins (for the doxygen tags that Iâm adding).
So do you have any recommendations for workflow and for how reviewers can provide input in an easier fashion than saying, âon the blah-blah-blah.html page, third para in the \this-tag, the âold-textâ should be ânew-textâ?
In theory I know that I can use Latex to create a PDF, which would offer lots of commenting ability. But then the look-and-feel and navigation is so different from whatâs desired/delivered to the customer that I doubt the value of such a time-consuming step.
Thanks for your thoughts,
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.