Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

50%
+0 −0
Q&A Should I have an introducing paragraph in every chapter of my description?

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...

1 answer  ·  posted 10y ago by mart‭  ·  last activity 4y ago by System‭

#3: Attribution notice added by user avatar System‭ · 2019-12-08T03:21:23Z (over 4 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 user avatar mart‭ · 2019-12-08T03:21:23Z (over 4 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 user avatar System‭ · 2014-01-31T11:09:59Z (about 10 years ago)
Original score: 4