How to write internal documentation that works - Deepstash
How to write internal documentation that works

How to write internal documentation that works

Curated from: zapier.com

Ideas, facts & insights covering these topics:

5 ideas

·

284 reads

3

Explore the World's Best Ideas

Join today and uncover 100+ curated journeys from 50+ topics. Unlock access to our mobile app with extensive features.

Creating internal documentation

Creating internal documentation

When creating documentation, you're not speaking to people with institutional knowledge.

You're speaking either to people who sit outside your team and aren't privy to your department's lingo, or to the newbies who don't yet know their CRMs from their CMSs. 

2

90 reads

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. 

If your internal docs are so convoluted that you break down every single process and concept within that process in agonizing detail, you and your readers are in for a rough time. You're also going to have a field day when something inevitably changes and you need to update your docs to match. 

3

56 reads

Keep your processes straightforward

If the process is complicated, the documentation will be too. 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. 

4

54 reads

Replace jargon with plain language

Whether it's training materials, employee handbooks, or standard operating procedures, laying out everything in a non-daunting way can bring new team members up to speed faster.

Steven Pinker describes this phenomenon as "the curse of knowledge." He coined the term to describe what happens when experts overestimate the knowledge level of non-experts. We tend to assume too much knowledge, don't provide enough context, and fail to define abbreviations or jargon we take for granted. 

3

45 reads

Include broader context about each team

Having a strong company culture isn't something you can just declare. It takes deliberate action to bring people together and to make every department accessible. 

So: how do clear communications better company culture? For one thing, internal documents are a great way to establish the company in terms of character and style for employees. If employees feel like they're a part of something that they know and understand, they'll perform better. 

3

39 reads

IDEAS CURATED BY

saisha

Sharing is caring

Saisha 's ideas are part of this journey:

De-escalate Office Tension

Learn more about communication with this collection

How to create a positive work environment

Conflict resolution strategies

Effective communication in the workplace

Related collections

Read & Learn

20x Faster

without
deepstash

with
deepstash

with

deepstash

Personalized microlearning

100+ Learning Journeys

Access to 200,000+ ideas

Access to the mobile app

Unlimited idea saving

Unlimited history

Unlimited listening to ideas

Downloading & offline access

Supercharge your mind with one idea per day

Enter your email and spend 1 minute every day to learn something new.

Email

I agree to receive email updates