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

60%
+1 −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?

I concur that Does DRY (Don't Repeat Yourself) Apply to Documentation? pretty much answers the question on what is best for the user. However, the question was: Which one is more futureproof? ...

posted 7y ago by System‭  ·  last activity 5y ago by System‭

Answer
#3: Attribution notice added by user avatar System‭ · 2019-12-08T08:02:24Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/33494
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar System‭ · 2019-12-08T08:02:24Z (almost 5 years ago)
I concur that [Does DRY (Don't Repeat Yourself) Apply to Documentation?](https://writing.stackexchange.com/questions/33529/does-dry-dont-repeat-yourself-apply-to-documentation) pretty much answers the question on what is best for the user.

However, the question was:

> Which one is more futureproof? (This tool is here to stay so there is no replacement option.)

In your case, as much as I don't want to say this - referring might turn out better in the long run. Here's why:

1. As time goes by, you'll keep on accumulating duplicate, hard-coded content. 
2. At some point it will become impossible to maintain it, so you'll begin offering outdated or erroneous content to customers.
3. Your users will not be able to do their job because they'll be getting outdated content.
4. You'll end up with bad content and unhappy users.

With your particular setup, I'd say that "correct content available through timely and accurate referral" trumps "all the content in the right place at the right time".

#1: Imported from external source by user avatar System‭ · 2018-02-05T09:50:30Z (almost 7 years ago)
Original score: 6