Tech Biz Writing

First draft
Learning curve: The time needed to assimilate the brief. It’s derived from a graphical curve illustrating the rate of learning against time. The curve tends to rise steeply in the beginning, before reaching a plateau. If the effort is continued, another jump occurs prior to settling down to a further plateau.

Heading weight: The importance given to a heading by means of its case, position on the page, underlining, italics &c. A chapter heading has a higher “weight” than a subheading.

Pagination: Page numbering. Many systems exist, but generally, those used in Tech. Pubs. will be more informative than decorative.

Style of writing
Man-machine languages: Abbreviated languages, almost akin to software, which, in theory, can be read both by automated machines and their human operators. Much vaunted in recent years, but experiencing problems of implementation.
Style: In the sense used here, style is a function of textual narrative. It’s characteristics are: clarity, cadence, and appropriateness. Bad style employs jargon, cliché, inappropriate ornament, and a use of stale imagery that closes down thought.

Technical vetting
Validation: The act of vetting a draft for technical accuracy and balance of interpretation.

Editing
Editing function: In technical writing an editor is concerned with three aspects of a draft:

* Does it conform to spec or house style?
* Is the flow of material logical?
* Is the grammar and punctuation correct?

Principles of editing: An editor checks a manuscript for:
* Conformity of headings to spec
* Pagination
* Paragraph numbering
* Contents list reflecting text
* Layout of illustrations
* Unusual or ugly word usage
* Undefined abbreviations
* Unnecessary words
* Unexplained technical terminology
* General balance
* Ambiguities
* Punctuation
* Construction
* Spelling.

Next : 56. Reinforcements - Final draft

This entry was posted on Tuesday, March 6th, 2007 at 8:30 pm and is filed under Technical Writing. You can follow any responses to this entry through the RSS 2.0 feed. Responses are currently closed, but you can trackback from your own site.