Agent SkillsPaca-AI/paca › paca-doc

paca-doc

GitHub

用于在Paca平台编写或更新功能、任务或主题的技术文档。支持指南、参考手册、架构设计及BDD场景等类型,自动加载上下文并保存至Paca,禁止生成本地文件。

skills/paca-doc/SKILL.md Paca-AI/paca

Trigger Scenarios

需要为已完成的功能编写文档 撰写操作指南或运行手册 更新现有文档 创建规范或架构文档 生成BDD验收测试场景

Install

npx skills add Paca-AI/paca --skill paca-doc -g -y
More Options

Use without installing

npx skills use Paca-AI/paca@paca-doc

指定 Agent (Claude Code)

npx skills add Paca-AI/paca --skill paca-doc -a claude-code -g -y

安装 repo 全部 skill

npx skills add Paca-AI/paca --all -g -y

预览 repo 内 skill

npx skills add Paca-AI/paca --list

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

  1. Resolve any reference from the user's message:
    • #42, ABC-42get_task_by_number to read the feature being documented
    • Doc title or ID → list_documentsget_document to load the existing doc
    • Free-text topic → list_documents first to verify no duplicate already exists; if a similar doc is found, offer to update it instead of creating a new one
  2. Call list_documents and read related docs — architecture, existing guides, BDD scenarios, API references. Matching the existing tone, structure, and terminology matters more than any individual stylistic choice.
  3. If documenting a task, call get_task + list_task_activities to 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_document with the title and full Markdown content. Call list_doc_folders first to find the right folder; use create_doc_folder if 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_comment on 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-setup to 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

Same Skill Collection

skills/paca-breakdown/SKILL.md
skills/paca-clarify/SKILL.md
skills/paca-do/SKILL.md
skills/paca-epic/SKILL.md
skills/paca-estimate/SKILL.md
skills/paca-prioritize/SKILL.md
skills/paca-setup/SKILL.md
skills/paca-sprint/SKILL.md
skills/paca-test/SKILL.md
skills/paca/SKILL.md

Metadata

Files
0
Version
1a37f10
Hash
cd5636c0
Indexed
2026-07-05 14:57

trang chủ - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-07-08 20:00
浙ICP备14020137号-1 $bản đồ khách truy cập$