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

How should I handle repeating parts in a technical description?

+1
−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 engineers. Because of the sales aspect, I need should emphasize all the elements that make us unique. Several parts will repeat throughout the plant, other parts I need to describe that can hardly be placed in one specific logical block - like interconnecting pipework or control.

My idea is to describe components when they first show up as a subchapter of the block they are in, and reference this subchapter when a component shows up in another block. Is there a better way to do this?

Edit to add: An alternative would be to have the component descriptions in every place the component shows up. Some would be repeated two or three times. This would pad the document. The pro would be that a reader who just looks up one part of the process does not need to jump around the whole text, but I would have to trust my readers to skip the parts they already read elsewhere. What to do?

History
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/10198. It is licensed under CC BY-SA 3.0.

0 comment threads

0 answers

Sign up to answer this question »