reviewer process - for HTML "doc"

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

Hello, TechWR-L-ers,

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,
-Monique
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.

Learn more: http://bit.ly/NNcWqS

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: RE: [BULK] Re: The word "documentarian"
Next by Author: Re: Graphics Question
Previous by Thread: Re: Structured writing = commodified writing
Next by Thread: Re: reviewer process - for HTML "doc"


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads