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.
We (my group of writers) are in the code, and yes, we fix it when it
needs fixing. Of course we do this because we build our SDK docs from
the code comments (.NET and Java) and we expect that any code visible
to a customer should be well-done in all respects.
On 4/20/05, John Posada <jposada01 -at- yahoo -dot- com> wrote:
> I'm using an application called CAST that outputs reports about code.
> Once of the outputs is any code comments.
> I'm importing the report into FM. Natuarally, I'm spell checking the
> document and sometimes I get a hit on the code comment, similar to
> the following:
> "Exectute on all entities if no entity type specified".
> In the document, would you correct the spelling of "Exectute" or
> would you send a note to the developer. wait for him to fix it, and
> if he does, then make the change in the doc?.
> John Posada
> Senior Technical Writer
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.