: Re: How should I handle repeating parts in a technical description? I'm about to write a technical description for an industrial process. The description will follow logical blocks, or blocks from

@Berumen699

Vote Up Vote Down

You say it's a sales document, aimed at engineers. In that case, describing every part of your process in detail -- including the non-unique ones -- seems to me both unnecessary and counterproductive. Your readers will get bored out of their minds, will start skimming through your document, and will probably miss the unique aspects of your process. Result: no sale.

My advice is to have an executive summary of the process at the front, in which only YOUR unique stuff is detailed. Everything else in the process would be described as succinctly as possible. Then, the main body of your document would repeat the process description, but explaining all parts of the process (although still highlighting your unique stuff).

A glossary of terms is also a good idea. In the text, use a different font for terms in the glossary, so readers know they've got help if they want it.

p.s. My primary job is scientist/engineer.

(0)

Login to post a comment!