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

Dashboard
Notifications
Mark all as read
Q&A

Should I have an introducing paragraph in every chapter of my description?

+0
−0

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?

Why does this post require moderator attention?
You might want to add some details to your flag.
Why should this post be closed?

This post was sourced from https://writers.stackexchange.com/q/10199. It is licensed under CC BY-SA 3.0.

0 comment threads

1 answer

+0
−0

I think an abstract or quick summary isn't a bad idea at all, especially if your audience is not necessarily familiar with the process or the parts, or if there's a lot of jargon involved.

I may not remember the difference between the Widgetizer and Widget Processing, but if you explain "The Widgetizer is the machine which inserts the ding-dong into the hoo-ha" and "Widget Processing is the process of moving fully interlocked widgets off the assembly line into the shipping boxes," I'll know which chapter I need.

Why does this post require moderator attention?
You might want to add some details to your flag.

0 comment threads

Sign up to answer this question »

This community is part of the Codidact network. We have other communities too — take a look!

You can also join us in chat!

Want to advertise this community? Use our templates!

Like what we're doing? Support us! Donate