Software Practices

Verify Commands, Paths, and Links

DOCS-VERIFY-COMMANDS-PATHS-AND-LINKS

DocumentationVerificationTooling
Give feedback

Summary

Check commands, file paths, and linked references because readers treat them as executable instructions. Note assumptions when credentials, services, or platforms prevent a full run.

Rule

Verify example commands, file paths, and linked references.

Why

Commands, paths, and links are executable instructions in disguise. A stale cargo command, moved file path, or broken reference sends readers and agents down a false path even when the surrounding prose is well written.

Helps

  • Keeps docs operationally accurate and reduces repair time for readers following examples.

Limits

Some commands require credentials, services, or platforms that cannot be run locally. Mark those assumptions and verify the parts that can be checked.

Agent Instruction

Verify example commands, file paths, and linked references because they act like executable
instructions.

Mechanisms

Supported by shell checks, link checkers, doctests, cargo doc, rendered-preview review, and explicit skipped-check notes when a command cannot be run.

References