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:My little .H From:Dennis Carothers <dcarothers -at- BGS -dot- COM> Date:Tue, 4 Feb 1997 15:36:39 EST5EDT
Thanks for the timely and very helpful offline responses to my query
about formatting programmer's header files.
In brief, the responses were:
1. Get the spelling, punctuation, grammar, etc. right.
2. Use your development group's standard, if there is one.
3. Follow programmer's reference standards if there isn't.
4. Trust your own sense of clean layout.
Bottom line: it's a special kind of doc, you've got to mind those /*
and */, but it's still a doc.
Dennis Carothers
dcarothers -at- bgs -dot- com
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
