opencode-documentation-writer (0.2.0)
Installation
registry=npm install opencode-documentation-writer@0.2.0"opencode-documentation-writer": "0.2.0"About this package
opencode-documentation-writer
Documentation writing agents for opencode.
Installation
Install this package in an opencode plugin workspace with npm or bun, then load the exported plugin from your opencode configuration.
Responsibilities
The librarian is responsible for read-only discovery of existing documentation, source files, and planning context before any writing begins.
The documentation-writer is responsible for writing documentation and documentation plans, focusing on non-behavioral changes that do not alter product code behavior.
By default, the documentation-writer can use opencode's built-in file modification tools only for documentation paths:
docs/**README.md*/README.md
Its bash permission is denied, and the librarian remains read-only.
Local project configs can replace the editable documentation path allowlist through plugin options:
[
"opencode-documentation-writer",
{
"editablePaths": ["docs/**", "adr/**"]
}
]
When editablePaths is provided, it replaces the defaults rather than merging with them.
Plan records
Documentation planning records are stored under docs/plans as semantic HTML so each plan can preserve structured intent, evidence, and writing steps.
Tools
documentation_file_planrecords a file-level documentation plan.documentation_write_planwrites documentation from an approved plan.
Dependencies
Peer dependencies
| ID | Version |
|---|---|
| @opencode-ai/plugin | 1.15.6 |