Code Comments, Code Reviews and Tech Writers

Subject: Code Comments, Code Reviews and Tech Writers
From: "Dave Neufeld" <Dave_Neufeld -at- spectrumsignal -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 5 Oct 2004 15:03:24 -0700

Hi doxygen (and similar) users,

Are any of you involved in formal code reviews to check/edit the comments for embedded documentation? If so, howz that workin' for ya?

We're trying to improve integration of embedded documentation within our code base for our SDKs, along with other improvements in our code review process. As the technical writer for the department, I'm trying to swim further upstream in the s/w life cycle to effectively contribute to the content, quality and consistency of the embedded documentation. So far, it's been difficult to access the code before code-freeze to edit the comments. Therefore, I want to incorporate myself into the formal schedule for code reviews (as long as that happens for the projects... <smirk>).


> David Neufeld [ Lead Technical Writer ]
> Spectrum Signal Processing Inc.
mailto:dave_neufeld -at- spectrumsignal -dot- com
> Confidential information may be contained in this message. If you are not the addressee indicated in this message please destroy this Message and kindly notify the sender by reply email.


ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed!

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 for more resources and info.


Previous by Author: Re: Tools: Weird Word spacing problem solved
Next by Author: eLearning / Multimedia Style Guides
Previous by Thread: Re: Software review of AuthorIt
Next by Thread: Re: Code Comments, Code Reviews and Tech Writers

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

Sponsored Ads