Choosing Tools for Documentation Print

  • 0

What to store it in.

WHAT THE OPTIONS ARE

Shared document storage A wiki or knowledge base tool An internal site Paper, for some purposes Purpose-built systems for particular records

WHAT TO ESTABLISH BEFORE CHOOSING

Who needs access and from where Whether it works offline or with poor connectivity Whether it supports search Whether content can be exported What it costs

WHY EXPORT MATTERS MOST

A tool holding your documentation that you cannot leave controls you.

WHAT TO TEST

The export, before committing.

WHY OFFLINE ACCESS MATTERS

Documentation needed during an outage is needed when systems are down.

WHAT TO KEEP AVAILABLE OFFLINE

Recovery procedures and critical contacts.

WHAT TO ESTABLISH ABOUT ACCESS

Who can read, who can edit, who administers.

WHAT TO AVOID

Tools requiring training to use Tools where adding content is difficult Documentation spread across several tools

WHY DIFFICULTY MATTERS

Friction means nothing is written.

WHAT TO PREFER

Whatever people will actually use.

WHY

An adequate tool that is used beats a better one that is not.

WHAT TO ESTABLISH

That the business, not an individual, owns the account.

WHY

Documentation locked in a departed person's account is lost.

WHAT TO BACK UP

Everything, in a form readable without the tool.

WHAT TO REVIEW

Whether the tool still suits as the business grows.


Was this answer helpful?
Back

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


Trustpilot