Post History
I'm about to write a technical description for an industrial process. The description will follow logical blocks, or blocks from the PFD of the process. This a sales document aimed at (mostly) engi...
Question
technical-writing
#3: Attribution notice added
by
System
·
2019-12-08T03:21:23Z (almost 5 years ago)
Source: https://writers.stackexchange.com/q/10199 License name: CC BY-SA 3.0 License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision
by
mart
·
2019-12-08T03:21:23Z (almost 5 years ago)
I'm about to write a technical description for an industrial process. The description will follow logical blocks, or blocks from the PFD of the process. This a sales document aimed at (mostly) engineers. My idea is to have a short paragraph at the start of every chapter, that will explain the purpose of the block to be described and notable inputs and outputs. My thinking is that the document will probably not only be read in one sitting, but that someone will come back to it to look up specific things. So I want to help the readers to orient themselves. The only downside I see is that's a little extra text. **Should I do this, is there a better way to make my description accessible?**
#1: Imported from external source
by
System
·
2014-01-31T11:09:59Z (almost 11 years ago)
Original score: 4