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 Is it better to repeat steps listed elsewhere in a manual, or to refer the reader to where the steps are listed elsewhere in the manual?

We have a tool that we cannot replace that does not support single sourcing. As a result, with instructions that involve the same node, we either repeat the same dozen steps over and over, or refer...

2 answers  ·  posted 6y ago by Lefty G Balogh‭  ·  last activity 4y ago by System‭

#3: Attribution notice added by user avatar System‭ · 2019-12-08T08:02:22Z (over 4 years ago)
Source: https://writers.stackexchange.com/q/33492
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar Lefty G Balogh‭ · 2019-12-08T08:02:22Z (over 4 years ago)
We have a tool that we cannot replace that does not support single sourcing. As a result, with instructions that involve the same node, we either repeat the same dozen steps over and over, or refer the user to say _chapter 2 sectionXY23_ to perform steps 1-17 and then carry out step 2 and 3 from here.

The first alternative is a lot more user friendly but heavy on maintenance. The second solution is really awkward but can be maintained.

Which one is more future-proof? (This tool is here to stay so there is no replacement option.)

#1: Imported from external source by user avatar System‭ · 2018-02-04T13:45:41Z (about 6 years ago)
Original score: 8