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 How much humour is effective in technical documentation?

The general rule in tech comm is to avoid humor, and I think the main points of consideration are: audience, context, and localization - if you're considering this at all. Speaking specifically a...

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

Answer
#3: Attribution notice added by user avatar System‭ · 2019-12-08T08:03:19Z (almost 5 years ago)
Source: https://writers.stackexchange.com/a/33528
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar Stephani Clark‭ · 2019-12-08T08:03:19Z (almost 5 years ago)
The general rule in tech comm is to avoid humor, and I think the main points of consideration are: audience, context, and localization - if you're considering this at all.

Speaking specifically about the localization concern, the translation of idiomatic language is an important consideration, but another significant concern is cultural interpretations of your humor.

I saw as interesting presentation at LavaCon last year where Jon Ann Lindsey, a Content Strategist from Google, spoke about their own attempts and research on this.

In synopsis: Google encourages their staff to be "Googly" and they did a large case study where they had focus groups from something like 40 different countries look at their documentation and actually had someone sit down with these groups in person to get feedback. They found that even the most minor humorous references (for example a picture of a cute penguin from their image library that was used in their documentation of the same) came across poorly in many regions. Some of this was unfamiliarity because people from some countries may have never seen a penguin. Others found it just plain infuriating and inappropriate that someone would try to insert "humor" or "cuteness" where they were trying to get technical information.

My major takeaway from this was: know your audience. If you're localizing content, this is even more difficult and imperative. Unfortunately, many of us don't have the same resources that Google does to conduct this type of research on a global scale, so it's probably best to stay in the realm of the cut and dry.

#1: Imported from external source by user avatar System‭ · 2018-01-25T15:22:29Z (almost 7 years ago)
Original score: 7