Creating internal documentation - Deepstash
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

De-escalate Office Tension

Discover 87 similar ideas in

It takes just

12 mins to read

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

88 reads

MORE IDEAS ON THIS

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...

3

43 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...

4

53 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 tha...

3

54 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 e...

3

37 reads

CURATED FROM

IDEAS CURATED BY

saisha

Sharing is caring

Related collections

Other curated ideas on this topic:

Creating your career

Creating your career

Most people never make a conscious decision about their careers and end up at a certain place, due to external factors and present opportunities. Their career path wasn't carved out or planned.

Creating your career is something that most people don't think of at an early stage when they are...

Get inside the right people's heads

Get inside the right people's heads

Knowledge often comes not only from asking the right questions but meeting with the right people. So don't just seek smart people. Seek the right smart people.

There are key insights experts can’t reveal. The most valuable insights often come from people who are closest to a p...

Why Is Workflow Documentation Important?

  • It helps optimize processes: You can’t improve upon what you can’t even see.
  • It ensures accountability: Without workflow documentation, anytime there’s a blocker, it’s a challenge to find out who or what caused it.
  • It takes the co...

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