cuioss Manage Plan Documents Skill
Domain-specific document management for request documents. Provides logical document names, schema validation, and structured read/update operations.
What This Skill Provides
- Logical document names (abstract from physical filenames)
- Declarative document type definitions
- Template-based document creation
- Section-based reading and updates
- TOON output format
When to Activate This Skill
Activate this skill when:
- Creating request documents (via template)
- Reading request documents with structured output
- Updating specific sections of request documents
For solution outlines, use the pm-workflow:manage-solution-outline skill instead.
Document Types
| Type | File | Purpose |
|---|---|---|
request |
request.md |
Original user input (source of truth) |
API: Noun-Verb Pattern
manage-plan-documents {document-type} {verb} [options]
Verbs
| Verb | Description |
|---|---|
create |
Create document from template |
read |
Read document (parsed or raw) |
update |
Update specific section |
exists |
Check if document exists |
remove |
Delete document |
Operations
Script: pm-workflow:manage-plan-documents:manage-plan-documents
request create
Create a request document.
python3 .plan/execute-script.py pm-workflow:manage-plan-documents:manage-plan-documents \
request create \
--plan-id {plan_id} \
--title "Feature Title" \
--source description \
--body "Full task description..."
Parameters:
| Parameter | Required | Description |
|---|---|---|
--plan-id |
Yes | Plan identifier |
--title |
Yes | Document title |
--source |
Yes | Source type: description, lesson, or issue |
--body |
Yes | Main content |
--source-id |
No | Source identifier (lesson ID, issue URL) |
--context |
No | Additional context |
--force |
No | Overwrite if exists |
Output:
status: success
plan_id: my-feature
document: request
file: request.md
action: created
document_info:
title: Feature Title
sections: title,source,source_id,body,context
read
Read a document with parsed sections.
python3 .plan/execute-script.py pm-workflow:manage-plan-documents:manage-plan-documents \
request read \
--plan-id {plan_id}
Output:
status: success
plan_id: my-feature
document: request
file: request.md
content:
_header: # Request: Feature Title...
original_input: Full task description...
context: Additional context...
Add --raw for raw markdown output.
update
Update a specific section.
python3 .plan/execute-script.py pm-workflow:manage-plan-documents:manage-plan-documents \
request update \
--plan-id {plan_id} \
--section context \
--content "Updated context information..."
Parameters:
--plan-id(required): Plan identifier--section(required): Section name to update (e.g.,context,original_input)--content(required): New content for the section
Output:
status: success
plan_id: my-feature
document: request
section: context
updated: true
exists
Check if document exists.
python3 .plan/execute-script.py pm-workflow:manage-plan-documents:manage-plan-documents \
request exists \
--plan-id {plan_id}
Output:
status: success
plan_id: my-feature
document: request
file: request.md
exists: true
Returns exit code 0 if exists, 1 if not.
remove
Remove a document.
python3 .plan/execute-script.py pm-workflow:manage-plan-documents:manage-plan-documents \
request remove \
--plan-id {plan_id}
Output:
status: success
plan_id: my-feature
document: request
file: request.md
action: removed
list-types
List available document types.
python3 .plan/execute-script.py pm-workflow:manage-plan-documents:manage-plan-documents \
list-types
Output:
status: success
types:
- name: request
file: request.md
fields: 5
Error Handling
status: error
plan_id: my-feature
document: request
error: document_not_found
message: Request document does not exist for plan my-feature
suggestions[2]:
- Create the request document first
- Check plan_id spelling
Scripts
Script: pm-workflow:manage-plan-documents:manage-plan-documents
| Command | Parameters | Description |
|---|---|---|
request create |
--plan-id --title --source --body [--source-id] [--context] [--force] |
Create request document |
request read |
--plan-id [--raw] |
Read document (parsed or raw) |
request update |
--plan-id --section --content |
Update specific section |
request exists |
--plan-id |
Check if document exists |
request remove |
--plan-id |
Delete document |
list-types |
(none) | List available document types |
Architecture
See standards/architecture.md for:
- Declarative engine design
- Document definition schema
- Adding new document types
See standards/adding-document-types.md for:
- Step-by-step guide to add new types
Related Skills
pm-workflow:manage-solution-outline- Solution outline management (validate, read, list-deliverables)
Integration Points
With plan-init
Plan initialization creates request document:
python3 .plan/execute-script.py pm-workflow:manage-plan-documents:manage-plan-documents \
request create \
--plan-id $PLAN_ID \
--title "$TITLE" \
--source description \
--body "$BODY"
With solution-outline-agent
The thin agent reads the request document:
python3 .plan/execute-script.py pm-workflow:manage-plan-documents:manage-plan-documents \
request read \
--plan-id $PLAN_ID
Then write solution outline using pm-workflow:manage-solution-outline skill.
With file_ops
This skill uses file_ops utilities (atomic_write_file, base_path) directly for file I/O. Use manage-files for non-typed documents.