Menu
Generate or update docstrings, ADRs, README sections, cookbook recipes, or user guides following Katana's documentation standards.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Write comprehensive tests using project conventions: AAA pattern, edge-case checklist, httpx.MockTransport, conftest fixtures, parametrize where it reads better than copy-paste.
Audit Prefab UI card builders (`build_*_ui` in `katana_mcp_server/src/katana_mcp/tools/prefab_ui.py`) for user-centric content: real names over IDs, no redundant text dumps, named helpers over ad-hoc rendering. Reports findings; does not modify code. Use when reviewing card UX or after touching `prefab_ui.py`.
Groom the Rolling Backlog (project #5) by reading current state and proposing diffs — not re-deriving the queue from scratch. Surfaces drift between issue state and project status, missing classification, and stale priorities. Asks per-category confirmation before mutating the board.
Quick pre-flight validation of staged and unstaged changes before committing. Lighter than the verifier/code-reviewer agents — focuses on catching common mistakes in the current changeset.
Scan editable code for tech debt, anti-patterns, and improvement opportunities across 5 categories. Reports findings; the code-modernizer agent applies fixes.
Open a PR for the current feature branch — self-review the diff, organize commits, push, create the PR, wait for CI and review, then address feedback. Use when implementation is complete and ready for review.
| name | generate-docs |
| description | Generate or update docstrings, ADRs, README sections, cookbook recipes, or user guides following Katana's documentation standards. |
| allowed-tools | ["Read","Write","Edit","Grep","Glob","Bash(uv run poe format)","Bash(uv run poe docs-build)","Bash(ls docs/adr/*)"] |
Write or update docs (docstrings, ADRs, README, cookbook, guides) using project standards.
| Type | Goes In | When |
|---|---|---|
| Docstring (Google style) | inline | public functions/classes/modules |
| ADR | docs/adr/NNNN-*.md | architectural decision |
| README section | the relevant README.md | new package or major feature |
| Cookbook recipe | docs/COOKBOOK.md | new usage pattern |
| User guide | docs/*.md | complex feature needing step-by-step |
def unwrap_as(response: Response, expected_type: type[T]) -> T:
"""Extract and validate a parsed response as the expected type.
Args:
response: The HTTP response to unwrap.
expected_type: The type to validate the parsed response against.
Returns:
The parsed response cast to the expected type.
Raises:
AuthenticationError: If 401.
ValidationError: If 422.
APIError: For other non-success status codes.
"""
ls docs/adr/*.md | grep -o '[0-9]\{4\}' | sort -n | tail -1
Increment, copy docs/adr/template.md, fill in. Update docs/adr/README.md index.
uv run poe format
88 char line length, ATX headers (#, not ===).
If updating MkDocs content:
uv run poe docs-build
harness-kit:documentation-writer skill — generic progressive-disclosure doc style/review skill — flags missing or outdated docstringsCLAUDE.md "Detailed Documentation" — canonical project doc map