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 Is writing "Bad practice"-notes in tech guides bad style?

It's very important to show users what they should not do and even more important is to explain why they should not do this. Think of a kid: you tell it not to touch the hot surface. ... Guess w...

posted 6y ago by Secespitus‭  ·  last activity 4y ago by System‭

Answer
#4: Attribution notice removed by user avatar System‭ · 2019-12-12T23:01:19Z (over 4 years ago)
Source: https://writers.stackexchange.com/a/32447
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:39:30Z (over 4 years ago)
Source: https://writers.stackexchange.com/a/32447
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-08T07:39:30Z (over 4 years ago)
It's very important to show users what they should _not_ do and even more important is to explain _why_ they should not do this.

Think of a kid: you tell it not to touch the hot surface.

... Guess what will happen five minutes later.

If you instead told the little kid that it will hurt very bad if they touch the surface because it's very hot, hotter than a candle, they will think about it twice. Depending on their experience with candles this might still lead to problems, but there will be a lot less incidents.

You want to go for the latter approach and save as many kids from hurting themselves as you can by telling them _what_ they should not do and _why_ they should not do it.

Your points are valid and important but the most important point is not to write:

"This will be faster, but less secure"

You want to write:

"This will save you a few minutes now, but once you have more than x users it will severely hinder your ability to perform [x] because you would have to manually change hundreds of lines - and if you miss one of them you will have a security hole that will easily grant an attacker access to your passwords."

Make it obvious why it's a bad idea. The more "You will have to do a lot more work" the better and a big "If you do this you are doomed once someone attacks you" will be better than anything else in getting people away from this action.

Don't forget to focus on the Good Practices though. It's important to mention the Bad Practices, but in general that should only be a few paragraphs or a little box at the bottom of a page with a big warning label. You are there to show them how to it right and explain why that is the right way to go, for example by mentioning the problems they will have if they don't follow your advice.

When it comes to security for example you have to know how your attackers think to be able to come up with countermeasures. If you always say that you don't need this knowledge because you are one of the good guys then the bad guys will have an easy target that knows nothing about their strategies. That would be like not telling your kids that people stealing your purse exist. Even if you don't want to encourage them to steal purses, you have to tell them that people do and how they normally do it so they can keep their purse secure.

#1: Imported from external source by user avatar System‭ · 2018-01-10T12:27:18Z (over 6 years ago)
Original score: 6