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 Can technical writing suck less

I currently have the prospect of writing a considerable amount of technical documentation (describing interactions with an extremely complex online service). I consider myself a reasonably proficie...

4 answers  ·  posted 9y ago by Michael B‭  ·  last activity 5y ago by System‭

#3: Attribution notice added by user avatar System‭ · 2019-12-08T05:04:54Z (about 5 years ago)
Source: https://writers.stackexchange.com/q/21091
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar Michael B‭ · 2019-12-08T05:04:54Z (about 5 years ago)
I currently have the prospect of writing a considerable amount of technical documentation (describing interactions with an extremely complex online service). I consider myself a reasonably proficient creative writer but that never seems to do me any good when writing tech docs.

The problem, of course, is the dryness. You can't explore the feelings and emotions of the Chromecast when it betrays the TV. It has to be 1. plug in 2. connect 3. watch.

There is the very (extremely) informal approach to documentation that a lot of consumer goods acquire but I often find those a little cringeworthy.

So is there a way to write technical documentation that doesn't put you to sleep, but also treat the reader like a three year old.

Is there a way to write 1. plug in 2. connect 3. watch. that the reader can feel engaged by. Is it possible to marry technical writing and creative writing successfully.

I would be very curious to see any examples that you think might have solved this problem.

#1: Imported from external source by user avatar System‭ · 2016-02-24T08:04:35Z (almost 9 years ago)
Original score: 15