Large companies often have huge amounts of written documentation. Salesforce, for example, has docs for end users, potential customers, employees of all stripes, external developers, and literally dozens of other categories of people.
-
Show this thread
-
Most of these pieces of documentation (save maybe github READMEs, and even those sometimes) are written by professional writers. But at scale, their output can't be just unstructured documents, like, just like opening a word doc and typing.
2 replies 0 retweets 24 likesShow this thread -
What they're writing has to be structured - broken down into component parts. This is for a number of reasons, but the one most interesting to us is _reuse_. They need to use pieces of a document in multiple places.
2 replies 0 retweets 31 likesShow this thread -
And why do they want to reuse elements? 1. Because the same information needs to appear in multiple places - developer docs & internal docs, for example - but when it changes, they don't want to have to hunt down all the places it's referenced and change each one, one at a time.
1 reply 0 retweets 33 likesShow this thread -
Single responsibility principle anyone?pic.twitter.com/1FSqk0miMj
2 replies 0 retweets 27 likesShow this thread -
But just like with code, reuse is not 100% good all the time. Every time you reuse something, you are creating a dependency between the two situations where you use it.
1 reply 3 retweets 37 likesShow this thread -
Those two situations now need to evolve their usage of that fragment at the same pace and in the same direction. Otherwise you get ... CONDITIONALS.pic.twitter.com/ak0PxfX9rf
1 reply 1 retweet 31 likesShow this thread -
And just like with code, in a small codebase [doc set] with only a few developers [writers] on it, a conditional here & there is fine. But when you've got hundreds of developers [writers]...it stops working quick.
1 reply 1 retweet 15 likesShow this thread -
Any existing conditional will attract more conditionals, because humans are nothing if not pattern followers. And when you come into the file, it sure looks like the thing to do is reuse the fragment but add your exception/special handling to the list!
1 reply 5 retweets 30 likesShow this thread -
I'm sure there's a law already out there about conditionals attracting more conditionals. If not, it's now Mei's First Law
4 replies 11 retweets 93 likesShow this thread
So: if there's a law already out there then use it else call it Mei's Law use it end
Loading seems to be taking a while.
Twitter may be over capacity or experiencing a momentary hiccup. Try again or visit Twitter Status for more information.