Docs Author Page
When to Use This Skill
docs-author runs this skill for each page
planned in the ## Information Architecture section of the docs-architect
report.
Prerequisites
Root steps run Invoke-DocsCommand.ps1 from the docs helper library that the Claude customization push-down delivers, under PowerShell 7.4 or later. Without that library every root step in this skill is unavailable; the docs MCP tools stay available.
Templates
The templates live in the templates/ folder of this skill, outside every
documentation root, so run_docs_check does not scan them.
| Template | diataxis_mode |
|---|---|
| tutorial.md | tutorial |
| how-to.md | how-to |
| explanation.md | explanation |
| architecture-overview.md | explanation |
| cli-reference.md | reference |
| http-reference.md | reference |
| config-reference.md | reference |
| api-reference.md | reference |
Steps
- Copy the template for the page's mode to the planned page path. Replace every
placeholder in the front matter:
owner,last_reviewed,audience,diataxis_modeandsurface_refs(the element ids the page covers). Each value is a JSON value on its own line. - For a reference page, call
generate_docs_referencewithworkspace_root,profileand optionallysnapshotandoutput_directory. The tool plans the generated blocks as a dry run and never writes pages. When the generated blocks must be written, report that the root step below is required. Root step (unavailable without the docs helper library):Invoke-DocsCommand.ps1 -Command generate-reference -Profile docs/documentation-estate/docs-profile.json -Write - Write the prose around the generated-block markers. Do not edit the content
between a
docs:generated:startmarker and itsdocs:generated:endmarker. - Link every new page from its root entry page (
README.mdorindex.mdof its documentation root). - Call
run_docs_checkwithworkspace_root,profileandpathsset to the pages written, and fix every finding the check reports on those pages.
Result
Report the pages written and the exit code of the last run_docs_check call.