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

66%
+2 −0
Q&A How much humour is effective in technical documentation?

It depends on the audience Personally I feel that technical writing is far too dry. However as an engineer I've done plenty of it. I always try to add humour and levity to make it more enjoyable. ...

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

Answer
#4: Attribution notice removed by user avatar System‭ · 2019-12-20T00:53:24Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/42792
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-08T08:03:20Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/42792
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by (deleted user) · 2019-12-08T08:03:20Z (almost 5 years ago)
# It depends on the audience

Personally I feel that technical writing is far too dry. However as an engineer I've done plenty of it. I always try to add humour and levity to make it more enjoyable. This has had varying results.

Here is an example where I went overboard on the levity and it was well received. For a physics report my partner and I decided to use the thesaurus on every word we could without changing the meaning, replacing common words with their most obscure and convoluted synonym. The report is the most ridiculous and over the top word babble I have ever written, but it is technically correct. We received full marks and a slap on the wrist for 'cheek'.

Another time when writing my final year project report I was working on the 'why this project' section. The project was about a vision guided landing system for autonomous drones and we thought it would be appropriate to put the top reason as 'drones are cool'. This didn't go down well, we lost marks for being 'unprofessional'.

Unfortunately I have yet to understand how to tell the first audience from the second. Sometimes readers will appreciate it and sometimes they will crucify you for it. It's up to you to judge your audience and if you can get away with it. If you think you won't get in trouble for, please do it. The world of technical writing could use a little more levity.

#1: Imported from external source by user avatar System‭ · 2019-03-01T02:32:40Z (over 5 years ago)
Original score: 3