Knowledgebase

Tutorial: Writing Documentation for Your Business Print

  • zillionkinghostai, guide, howto, solution, zillionkinghost, hosting, support
  • 0

Capturing how things are done.

STEP ONE: PICK THE PROCESS

The one only you know, or the one you explain most often.

STEP TWO: DESCRIBE IT ROUGHLY

Talk it through as you would to a new person. Rough notes, or dictate it.

STEP THREE: ASK FOR STRUCTURE

"Turn this into a numbered procedure someone could follow without asking questions."

STEP FOUR: ASK WHAT IS MISSING

"What questions would someone following this have that it does not answer?"

That finds the gaps.

STEP FIVE: ADD THE FAILURE CASES

What to do when something goes wrong, and who to ask.

STEP SIX: FOLLOW IT YOURSELF

Actually do the task from the document. You will find errors.

STEP SEVEN: HAVE SOMEONE ELSE FOLLOW IT

The real test.

STEP EIGHT: DATE IT

State when it was written and when it was last checked.

WHAT THIS ENABLES

Delegation, continuity, and not being the only person who knows.


Was this answer helpful?
Back

Are you happy with your experience? Leave us a review on Trustpilot.


Trustpilot