paca-doc
GitHub用于在Paca平台编写或更新功能、任务或主题的技术文档。支持指南、参考手册、架构设计及BDD场景等类型,自动加载上下文并保存至Paca,禁止生成本地文件。
Trigger Scenarios
Install
npx skills add Paca-AI/paca --skill paca-doc -g -y
SKILL.md
Frontmatter
{
"name": "paca-doc",
"description": "Write or update documentation for a feature, task, or topic in Paca Docs. Use when asked to document a completed feature, write a guide or runbook, update existing docs, create a spec or architecture document, or produce BDD scenarios. Documentation is saved in Paca — never created as local files.",
"compatibility": "Requires Paca MCP server. Run \/paca-setup if Paca tools are not available."
}
You are writing or updating documentation in Paca Docs. Documentation lives in Paca — never create local files for docs.
If no task or topic is specified, call list_tasks for recently completed tasks that have no linked document, and ask the user which feature to document.
Step 1 — Load project context
- Resolve any reference from the user's message:
#42,ABC-42→get_task_by_numberto read the feature being documented- Doc title or ID →
list_documents→get_documentto load the existing doc - Free-text topic →
list_documentsfirst to verify no duplicate already exists; if a similar doc is found, offer to update it instead of creating a new one
- Call
list_documentsand read related docs — architecture, existing guides, BDD scenarios, API references. Matching the existing tone, structure, and terminology matters more than any individual stylistic choice. - If documenting a task, call
get_task+list_task_activitiesto read the implementation details and any design decisions recorded in comments — these are often the most valuable content to capture.
Step 2 — Identify doc type and draft outline
Based on context, identify the type:
- Guide / tutorial — step-by-step, outcome-oriented, written for someone doing it for the first time
- Reference — exhaustive API, config, or CLI reference
- Architecture / design doc — decisions, tradeoffs, diagrams (as Markdown)
- BDD / acceptance spec — Gherkin-style scenarios
- Runbook — operational steps for a known procedure
If the type is obvious from the task or request, proceed directly. Only ask the user to confirm the outline when the type is genuinely unclear or the scope is large.
Step 3 — Write the documentation
Write complete, clear Markdown:
- Active voice and present tense
- Code examples and command snippets where they aid understanding
- Link to related Paca docs by title or task number
- No "last updated" timestamps, no "Created by Claude" lines — Paca tracks history
- No placeholder sections ("TBD", "coming soon") — write real content or omit the section
Step 4 — Save to Paca
- New document: call
create_documentwith the title and full Markdown content. Calllist_doc_foldersfirst to find the right folder; usecreate_doc_folderif none fits. - Existing document: call
update_document. Integrate new content with the existing structure rather than appending everything at the end. - If the doc is tied to a task, call
add_task_commenton that task linking to the doc (e.g. "Documentation written: [link]").
Report back: document title, the folder it was saved in, and the document ID.
If Paca MCP is not connected
Paca MCP tools are not available. Run
/paca-setupto configure the connection.
Tool reference
Documents: create_document · update_document · get_document · list_documents · list_doc_folders · create_doc_folder
Tasks: get_task · get_task_by_number · list_task_activities
Comments: add_task_comment
Projects: list_projects
Version History
- 1a37f10 Current 2026-07-05 14:57


