Skip to main content

Internal Tool Module Template

Create one module for each internal tool. Copy this structure when a new tool becomes useful enough for staff training.

Diagram showing internal tool documentation moving from tool purpose to access to common tasks to support to change log.

Tool name​

Short name and plain-language purpose.

Who uses it​

List the staff roles that should use the tool.

What it does​

Explain the workflow the tool supports. Avoid implementation details unless staff need them to operate the tool.

Access​

Document:

  • how access is requested
  • whether access requires the private network
  • who approves access
  • what to do when access fails

Do not publish private URLs, keys, or credentials here.

Common tasks​

List the top staff actions:

  • task one
  • task two
  • task three

Support​

Include:

  • owner
  • backup owner
  • support channel
  • escalation path

Change log​

Track visible workflow changes so staff know when behavior changed.

YYYY-MM-DD - Initial module created.