Re: reviewer process - for HTML "doc"

Subject: Re: reviewer process - for HTML "doc"
From: Lois Patterson <loisrpatterson -at- gmail -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- techwr-l -dot- com>
Date: Mon, 26 May 2014 12:42:54 -0700

Code Collaborator is good for this type of thing also. The reviewer could
look at the HTML output and the code page simultaneously, and then mark up
the comments or requested changes in Code Collaborator.


On Fri, May 23, 2014 at 8:06 AM, Robert Lauriston <robert -at- lauriston -dot- com>wrote:

> Do you have a code review tool like Review Board or Crucible? If not,
> could you install Review Board?
>
> Doxygen can output RTF, reviewers could use Word / LibreOffice change
> markup.
>
> On Thu, May 22, 2014 at 2:56 PM, Monique Semp
> <monique -dot- semp -at- earthlink -dot- net> wrote:
> > 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â?
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 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 loisrpatterson -at- gmail -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


References:
reviewer process - for HTML "doc": From: Monique Semp
Re: reviewer process - for HTML "doc": From: Robert Lauriston

Previous by Author: Use of "since" or "because"
Next by Author: RE: strange capitalization problem in Word 2010
Previous by Thread: Re: reviewer process - for HTML "doc"
Next by Thread: TechWhirl: Technical Communication Recap for May 23, 2014


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

Sponsored Ads


Sponsored Ads