Docs Writer /docs-writer

About this skill

Docs Writer reads your code so your users don't have to. It generates API references from signatures and docstrings, writes READMEs that actually explain the project, and builds guides from the patterns it finds in your tests and examples.

The examples aren't invented — they're extracted from your actual test suite and usage, then verified by running them. If an example doesn't execute, it doesn't ship. That single rule eliminates the most common docs rot: examples that lie.

It detects drift on every run and flags sections that no longer match the code, so documentation stays honest as the project evolves. Output is Markdown, MDX, or Docusaurus-ready pages.

Inputs

• repo_path · string
  Path to the repository or package.
• format · string
  markdown | mdx | docusaurus. Default: markdown.
• sections · array
  Optional: readme, api-reference, guides.

Outputs

• docs_path · string
  Path to generated documentation.
• drift_report · string
  Sections where docs and code disagree.
• examples_verified · number
  Count of examples that executed successfully.

Permissions

Deny-by-default: the skill can only use what it declares.

Manifest

{
  "spec": "agentskills.io/v1",
  "name": "docs-writer",
  "version": "1.9.0",
  "description": "Reads your codebase and generates API references, READMEs, and guides — with examples extracted from real usage and tests.",
  "inputs": {
    "repo_path": {"type": "string", "description": "Path to the repository or package.", "required": true},
    "format": {"type": "string", "description": "markdown | mdx | docusaurus. Default: markdown.", "required": false},
    "sections": {"type": "array", "description": "Optional: readme, api-reference, guides.", "required": false}
  },
  "outputs": {
    "docs_path": {"type": "string", "description": "Path to generated documentation."},
    "drift_report": {"type": "string", "description": "Sections where docs and code disagree."},
    "examples_verified": {"type": "number", "description": "Count of examples that executed successfully."}
  },
  "permissions": ["fs:read", "fs:write", "exec:shell"],
  "author": "Proseware",
  "category": "Writing"
}

Changelog