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.
I am presently reviewing documents that pertain to describing how a piece
of C code works. The document will eventually reach an audience of
developers who will eventually use this document to re-engineer code.
Therefore, every single functionality is explained in detail. I wanted to
know if we can have the following construction:
"Only when HHcnommi==HH_ENADIR, will the algorithm allow the message to be
sent to the HEH."
This is similar to
"Only if I see a blue car, will I open the gate."
The developers contention is that the stress should be on the consequences
first and the actions later. However, I have been arguing that the above
constructions negate the rules of English.
Am I right with this argument. Please reply me offline. I shall summarise
it for the rest if I find some interesting stuff.
