cursor-docmgr
Use the docmgr CLI to manage ticketed docs (create tickets, add docs, relate code files with file-note, update changelog, and search). Use when the user asks how to use docmgr, wants a docmgr command sequence, or needs docmgr best practices (file-note, quoting, doctor).
When & Why to Use This Skill
The cursor-docmgr skill empowers Claude to interface with the docmgr CLI, providing a structured workflow for managing ticketed documentation. It streamlines the process of creating design docs, relating specific code files to documentation via explanatory notes, and automating changelog updates. By bridging the gap between source code and technical records, it ensures project knowledge is searchable, maintainable, and deeply integrated with the development lifecycle.
Use Cases
- Structured Documentation Creation: Quickly initialize feature tickets and generate associated design, analysis, or playbook documents with standardized metadata.
- Code-Doc Traceability: Link specific source code files to documentation using the 'file-note' feature to explain the rationale behind implementation details for future reference.
- Automated Changelog Maintenance: Systematically update project changelogs by capturing ticket-specific entries and linking them to relevant file changes.
- Advanced Knowledge Discovery: Perform full-text searches or reverse lookups by file path to find relevant documentation and design decisions within a complex codebase.
- Workflow Validation: Use the 'doctor' command to audit ticket documentation health and ensure all required notes and relationships are correctly established.
| name | cursor-docmgr |
|---|---|
| description | Use the docmgr CLI to manage ticketed docs (create tickets, add docs, relate code files with file-note, update changelog, and search). Use when the user asks how to use docmgr, wants a docmgr command sequence, or needs docmgr best practices (file-note, quoting, doctor). |
Cursor Docmgr
Overview
Provide a reliable, copy/paste-friendly docmgr workflow for creating and maintaining structured ticket documentation.
Quick start
Shell safety: backticks
- Never paste markdown backticks (
`...`) into your shell unquoted.- Preferred: remove backticks.
- Alternative: wrap the arg in quotes.
Core workflow (per ticket)
- Create a ticket:
docmgr ticket create-ticket --ticket TICKET --title "..." --topics a,b - Add a doc:
docmgr doc add --ticket TICKET --doc-type design-doc --title "..."(oranalysis/reference/playbook) - Relate code files (notes required):
docmgr doc relate --ticket TICKET --file-note "/abs/path:why it matters" - Update changelog:
docmgr changelog update --ticket TICKET --entry "..." --file-note "/abs/path:reason" - Validate:
docmgr doctor --ticket TICKET
Search patterns
- Full-text:
docmgr doc search --query "..." [--topics ...] [--doc-type ...] - Reverse lookup by file:
docmgr doc search --file path/to/file.go - Directory lookup:
docmgr doc search --dir path/to/dir/
Reference
- Full workflow + conventions live in
references/docmgr.md.