Creating internal documentation is nobody’s favorite job, but no matter how much you dread documenting all the things, it’s nearly impossible to function as a business without it. Here are some tips for creating documentation that stands the test of time-and that people actually use.
Don’t get bogged down by the details
For overarching processes, it’s better to whittle down the writing to a digestible format, with enough detail for it to be comprehensible, but not so in-depth that any tiny change in the process would make the whole lot moot
Include broader context about each team
If employees feel like they’re a part of something that they know and understand, they’ll perform better
- At Zapier, we do this by breaking down our team structure and giving clear instructions on how to work cross-functionally
Keep your processes straightforward
If you can’t explain something in straightforward terms, you should correct the process until you can.
- Your processes-and the documents explaining them-should aim for what helps the most people, not what helps a few people the most.
Replace jargon with plain language
Lay out everything in a non-daunting way so that new hires can get up to speed faster
- The curse of knowledge is when experts overestimate the knowledge level of non-experts
- So, assume the reader can easily grasp the concept at hand, but take the time to explain it to them as though they’ve never heard of it
