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

So, I'm in the process on writing a hardening guide for Windows 10. Similar to http://hardenwindows10forsecurity.com/index.html, but different in scope and style. I wondered, if informing about "B...

1 answer  ·  posted 7y ago by CuttingWide‭  ·  last activity 5y ago by System‭

#3: Attribution notice added by user avatar System‭ · 2019-12-08T07:39:29Z (about 5 years ago)
Source: https://writers.stackexchange.com/q/32441
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar CuttingWide‭ · 2019-12-08T07:39:28Z (about 5 years ago)
So, I'm in the process on writing a hardening guide for Windows 10. Similar to [http://hardenwindows10forsecurity.com/index.html](http://hardenwindows10forsecurity.com/index.html), but different in scope and style.

I wondered, if informing about "Bad/Worst Practices" would be a thing that should be avoided?

The thing is, I read several blogs in the past that told to avoid this. According to them to not give the user the knowledge that something like this exists. Honestly I feel this is quite a weak argument. If I try to explain to users why they should do something in a specific way, might it not be meaningful to tell them why **not** to do it in a different one?

From a didactic viewpoint I would consider the following points regarding this:

- Give only very general informations, not an actual How-To. This would mean they still have to look somewhere else - fine, if they want.
- No URLs to external guides that show this "Bad Practice" in action. Similar to the first point. If they want to use it still, I can't prevent it.
- Make it clear by a panel that this is considered as "Bad/Worst Practice" and should not be used for given reasons.

I think this sounds reasonable, but as always: Open for additional/different thoughts.

#1: Imported from external source by user avatar System‭ · 2018-01-10T09:32:42Z (almost 7 years ago)
Original score: 7