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:RE: Code Annotation in HTML pages From:Paul Hanson <phanson -at- Quintrex -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 11 Nov 2009 11:01:26 -0600
Exactly. For a project that required me to change 20+ HTML files with the same blurb, I used <!--project number--> so I could search for it in Dreamweaver and get a list of exactly what files I had to change so I could audit the tracking document I maintain vs. the actual HTML files I had changed.
-----Original Message-----
From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Robert Lauriston
Sent: Wednesday, November 11, 2009 10:56 AM
To: TECHWR-L
Subject: Re: Code Annotation in HTML pages
I wouldn't put anything unprofessional in HTML comments, but I don't
see any problem with housekeeping-type comments (e.g. "this is for
beta releases only, hide for GA").
On Wed, Nov 11, 2009 at 7:13 AM, Paul Hanson <phanson -at- quintrex -dot- com> wrote:
> As a side note to the thread about programmers putting funny comments in their source code, do any of you who create HTML-based Help put comments in your pages? Do you worry about your users right-clicking, selecting View Source and seeing your comments?
>
> I routinely include a comment regarding what project is associated with a specific change. I find it easier to search for that project number if I'm researching something.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Help and Manual 5: The all-in-one help authoring tool. Full support for
team authoring with multi-user editing - both directly and in combination
with VSS-compatible source control systems. http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as PHanson -at- quintrex -dot- com -dot-
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Help and Manual 5: The all-in-one help authoring tool. Full support for
team authoring with multi-user editing - both directly and in combination
with VSS-compatible source control systems. http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
