Create Documentation Workflows
docs-createcommandsetup L1★57
opendatahub-io/odh-dashboard ↗What it does
Create new documentation from template or guidelines
Best for
Generating high-quality docs when project has strong template/guideline infrastructure and documentation must follow established patterns.
Inputs
- · Subject and doc type (frontend, backend, package, ADR)
- · File or package names mentioned
Outputs
- · Markdown doc file at appropriate path (docs/, packages/name/docs/, .claude/rules/)
- · No placeholder text (TODO, TBD, [Description])
- · Complete with template sections or guidelines applied
Requires
- · docs/templates/ (if they exist)
- · docs/guidelines.md
- · Source files being documented
Preconditions
- · CLAUDE.md and docs/guidelines.md exist
- · Template files present for the doc type
- · Source code or subject matter accessible for research
Failure modes
- · No template found = fallback to guidelines.md, risk of wrong output path
- · Placeholder text left = doc marked incomplete, rejected in review
- · Wrong output path = documentation not discoverable
- · Existing doc not checked = duplication created
Trust signals
- · Selects template first, falls back to guidelines
- · Prevents placeholder text (zero-tolerance policy)
- · Research-first before writing (reads source files)