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 How should I document a product release with an inherently flawed design?

This is essentially a business problem, which is not to say it is off topic, because technical writers exist to solve business problems. But it is not a problem the writer should try to solve on th...

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

Answer
#4: Attribution notice removed by user avatar System‭ · 2020-01-03T20:41:56Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/33256
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#3: Attribution notice added by user avatar System‭ · 2019-12-08T07:57:27Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/33256
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-08T07:57:27Z (almost 5 years ago)
This is essentially a business problem, which is not to say it is off topic, because technical writers exist to solve business problems. But it is not a problem the writer should try to solve on their own. You have to get guidance from the product manager.

However, there is a very good chance that the product manager has not thought this through, so you may have to go to them an lay out a set of options and their potential consequences:

1. Document the flaws clearly. Likely consequences: limited adoption. Upsides: avoid disappointing or misleading customers. Hopefully keep them interested in what you are doing for the next release.

2. Don't mention the flaws at all. Likely consequences: higher initial adoption followed by disappointment and possibly lawsuits when the flaws become apparent. You may turn customers off long term and not have the chance to win them back once the fixed version is released. Alternatively, you may survive the initial disappointment and ride the first mover advantage to a home run with the second release. 

3. Document around the flaws. That is, write up procedures that work around the design flaws. Likely consequences: The product may appear weirdly designed or over complicated on first release, which may not matter if it has unique functionality that people want. Second version can then be sold as a significant upgrade with improved ease of use. However, the time to develop, test, and document the workarounds could delay the release. 

Option three is way more common than most people may suspect.

#1: Imported from external source by user avatar System‭ · 2018-02-14T12:52:37Z (almost 7 years ago)
Original score: 19