OpenClaw EnterpriseDOCSGitHub

Base Driver documentation template

When writing or rewriting a base Driver contract, use the repository-owned technical-writing template. It is the canonical template used by the local technical-writing skill.

The required sections are Overview, Interface, IAM, Lifecycle, Limits, Troubleshooting, Implementations, and Related. Interface separates core operations from optional additions. IAM describes authorization, identity scope, and credential boundaries. Lifecycle distinguishes the Driver instance from the resources it manages.

Start with the Driver documentation inventory to find the existing owner. Base contracts belong in docs/reference/drivers/<capability>.md; backend configuration, setup commands, and backend-specific troubleshooting remain in implementation references. See the ComputeDriver contract for an applied example.

Search documentation