Write a How-To Guide#

Use this template whenever you want to document a task you may need to repeat.

Goal#

Describe the result in one sentence.

Example:

Install a tool, confirm it runs, and record the commands needed to update it later.

Requirements#

List anything needed before starting:

  • Operating system or device
  • Required app or CLI tool
  • Account access
  • Existing files or configuration
  • Network or permission requirements

Steps#

Write the steps in the order you would actually run them.

# Example command
tool --version

Keep each step focused on one action. If a step has a decision, explain which option you used and why.

Verify#

Add one or more checks that prove the task is complete.

# Example verification
tool status

Expected result:

  • The command finishes without errors
  • The output shows the expected version, status, file, or service

Troubleshooting#

Record fixes for problems you actually hit.

ProblemFix
Command not foundCheck the install path and shell PATH
Permission deniedConfirm account permissions or rerun with the required access
Version mismatchCheck the installed version and update the package

Notes#

Add context that may help later:

  • Why this approach was chosen
  • Links to official references
  • Things to avoid next time
  • Date tested