aboutsummaryrefslogtreecommitdiffstats
path: root/modules/development/pi-coding-agent/skills/documentation
diff options
context:
space:
mode:
authorArpit Chakladar <arpit@chakladar.me>2026-09-29 23:45:25 +0530
committerArpit Chakladar <arpit@chakladar.me>2026-09-29 23:45:25 +0530
commit33519df0fff478526d217d04190577b33c5bf7d0 (patch)
tree18f6ee9bb8101381212038d16099e59d250b7080 /modules/development/pi-coding-agent/skills/documentation
parent7975de6d03289bcc143137d5458486def5adc672 (diff)
parent871a29efd370088f669c4f2b9e20b8992406a444 (diff)
downloadhome-manager-config-33519df0fff478526d217d04190577b33c5bf7d0.tar.gz
home-manager-config-33519df0fff478526d217d04190577b33c5bf7d0.zip
Merge branch 'adding-pi-harness'
Diffstat (limited to 'modules/development/pi-coding-agent/skills/documentation')
-rw-r--r--modules/development/pi-coding-agent/skills/documentation/SKILL.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/modules/development/pi-coding-agent/skills/documentation/SKILL.md b/modules/development/pi-coding-agent/skills/documentation/SKILL.md
new file mode 100644
index 0000000..d7ad4bf
--- /dev/null
+++ b/modules/development/pi-coding-agent/skills/documentation/SKILL.md
@@ -0,0 +1,32 @@
+---
+name: documentation
+description: "Generate/update README/API/architecture docs from the actual implementation rather than inventing behavior."
+---
+
+# Documentation Skill
+
+Generate/update README/API/architecture docs from the actual implementation rather than inventing behavior.
+
+## Subagents
+When you need to delegate sub‑tasks, use the `pi-subagents` skill.
+
+**Example:** For a new feature, assign a **scout** to extract API signatures from the `service` module, another **scout** to gather usage examples from the `cli` package, and an **implementer** to generate the corresponding README and API docs sections simultaneously.
+
+*You may adapt the delegation pattern to fit the exact requirements of the codebase.*
+
+## Principles
+
+### Source of Truth
+- Read code first
+- Document what exists
+- Don't speculate on behavior
+
+### Types
+- README: project overview, setup, usage
+- API: public interfaces, parameters, returns
+- Architecture: module boundaries, data flow
+
+### Maintenance
+- Update with code changes
+- Delete stale documentation
+- Link to code references