This post is a great reminder that when writing technical documentation, your readers will just copy your examples verbatim a lot of the time.
You have to be thoughtful about things like sample code or example configurations because that’s actually going to be a lot of your customer’s production code and deployed configurations.
This applies outside of technical writing as well. People treat analogies and examples as just as canonical as the thing you’re teaching.
https://blog.thinkst.com/2023/08/default-behaviour-sticks-and-so-do-examples.html
Dare Obasanjo /
npub1l4…exuhy
2023-08-21 13:44:57
Author Public Key
npub1l4l93jaluhcmp24qqhsnz0wv4ld4lnyv5h09k2p7cssrjn5zwflscexuhyPublished at
2023-08-21 13:44:57Event JSON
{
"id": "4d58d5c97dbce4b44379659a58a7f159dc6468a1dc913a164f8a799387c7f380",
"pubkey": "fd7e58cbbfe5f1b0aaa005e1313dccafdb5fcc8ca5de5b283ec420394e82727f",
"created_at": 1692625497,
"kind": 1,
"tags": [
[
"proxy",
"https://mas.to/users/carnage4life/statuses/110927904628701918",
"activitypub"
]
],
"content": "This post is a great reminder that when writing technical documentation, your readers will just copy your examples verbatim a lot of the time. \n\nYou have to be thoughtful about things like sample code or example configurations because that’s actually going to be a lot of your customer’s production code and deployed configurations.\n\nThis applies outside of technical writing as well. People treat analogies and examples as just as canonical as the thing you’re teaching.\n\nhttps://blog.thinkst.com/2023/08/default-behaviour-sticks-and-so-do-examples.html",
"sig": "8f55044e594d822fa3b05b960a9e0b205286c00bbff0b3c9f149af09e38c111876e93c186801f7772084537ff471ed57bf7f096f532b6f3fd638d6638693039b"
}