1. How to Write Editing Comments For Authors
(Technical Communication/Technical Communication Lessons)

How to Write Editing Comments For Authors  I spent some time as a technical editor for the US Army. I was responsible for editing very technical materials produced by engineers, scientists and technicians ...

2. Technical Communications and Programming: The Economic Reasons for Commenting
(Technical Communication/Technical Communication Lessons)

... the code itself and more easily attain a comprehensive understanding of the program (7; 8). Elements of internal documentation—that is, imbedded source-code comments—were long ago thought to contribute ...

3. Technical Communication and Programming: Dissertation Study
(Technical Communication/Technical Communication Lessons)

Okay, recently I've had a lot of interest in my research into source-code comments. A bulk of my research was carried out during my doctoral dissertation study: a four-month long case study in which I ...

4. Technical Communication and Programming: Internal and External Documentation
(Technical Communication/Technical Communication Lessons)

There are some fundamental differences between a program's internal and external documentation. Internal documentation--that is, comments--should give a close explanation of specific things within the ...

5. The Use of Programming Source-Code Comments
(Technical Communication/Technical Communication Lessons)

Attached to this is a rather long article drawn from my dissertation research on the use of source-code comments in programming. Why is it published here rather than elsewhere? Well, the simple answer ...

6. Technical Communication and Programming: Using Writing Rules
(Technical Communication/Technical Communication Lessons)

... many programmers have probably already heard—multiple times—the arguments for really working to ensure their comments are up to date and informative. And in truth, judging from the open-source code I have ...

7. Feedback? Questions? Comments?
('Uncategorised Content')