ext_27952 ([identity profile] caramel-betty.livejournal.com) wrote in [personal profile] j4 2006-06-21 03:20 pm (UTC)

It depends. I spend a lot of my job turning technical information into customer documentation. Sometimes, I can turn huge documents into a tiny paragraph of warning. At other times, it's the other way round. It very much depends on the target audiences for the two documents, and their relative backgrounds.

Techie language isn't necessarily high-density information that the user cares about - it can just be wordy. For example, I sometimes see things which specify exactly what and when can happen where - what actions you can take, what functions you can use, what programming language constructs will work here. From the techie point of view, there's a lot of information there. From the user point of view, summarising this the other way around can be a lot of more useful ("It works on everything except...") or they've specified a lot of things that are exactly how you'd expect them to be. Other times, the technical documents are badly structured (from a user point of view) or repeat themselves a lot.

Some technical documents can be exactly the other way round, though. They assume high level of knowledge in the reader. The explanation of the document is having to provide enough gloss so that it makes sense to a layman (e.g. a business executive who's expected to nod and smile at appropriate points, and know how the buzzwords inter-relate), or to cater for a variety of concerns (e.g. a document that's shared between, and aimed at, technical people and marketing people).

Post a comment in response:

This account has disabled anonymous posting.
If you don't have an account you can create one now.
HTML doesn't work in the subject.
More info about formatting