A directory of resources inthe field of technical communication.


3 found.

About this Site | Advanced Search | Localization | Site Maps



Inspecting Requirements

Errors in requirements specifications translate into poor designs, code that does the wrong thing, and unhappy customers. Requirements documentation should be inspected early and often. Anything you can do to prevent requirements errors from propagating downstream will save you time and money. Karl Wiegers shows you how.

Wiegers, Karl E. StickyMinds (2004). Articles>Documentation>Engineering>Specifications


Mistakes Can Be Costly

In the aircraft industry, a number of factors have converged to highlight the importance of maintenance manuals.

Between the Lines (2007). Articles>Documentation>Engineering>Risk Communication


The Steel Bible: A Case Study of 20th Century Technical Communication   (peer-reviewed)   (members only)

The "steel bible" emerged in 1919 and went through 11 editions in 80 years. In its evolution we can see the shift from individual to group authorship, an increasing use of visual elements, and a physical change from a small, hand-held volume to a weighty desktop reference. In a textual analysis, we can see that it was essentially static, changing only by additions and deletions, as the industry evolved. The eventual closing of hundreds of plants and the migration of the industry to other countries can be seen in the change of publisher, the sudden absence of photography, and the international references. Originally, the steel bible came from the factory floor and the words of the plant managers, but by the 1990s, it was a highly-abstracted representation of knowledge. In the steel bible, we can see the history of the industry and the maturing of technical communication in the 20th century.

Johnson, Carol Siri. Journal of Technical Writing and Communication (2007). Articles>Documentation>History>Engineering

Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon