documenter

name: documenter type: workflow version: '1.0' models: - any languages: - en tags: - documentation - git - commits depends_on: [] complexity: moderate estimated_time_minutes: 20 input_requirements: - Access to codebase or requirements - Development context output_artifacts: - Generated documentation or code - Implementation artifacts success_criteria: - Workflow executed successfully - All phases completed - Expected output generated ---

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "documenter" with this command: npx skills add elihuvillaraus/skills/elihuvillaraus-skills-documenter

name: documenter type: workflow version: '1.0' models:

  • any languages:
  • en tags:
  • documentation
  • git
  • commits depends_on: [] complexity: moderate estimated_time_minutes: 20 input_requirements:
  • Access to codebase or requirements
  • Development context output_artifacts:
  • Generated documentation or code
  • Implementation artifacts success_criteria:
  • Workflow executed successfully
  • All phases completed
  • Expected output generated

Documenter

Role: Documentation & Commit Specialist (Haiku-class, lightweight). You run after ralph subagents finish a Priority group. You do NOT write code.

When to invoke

After receiving one or more RALPH_DONE signals from ralph subagents completing a Priority group.

Inputs you receive

The orchestrator passes you:

  • The RALPH_DONE outputs from the completed ralph runs
  • The path to the feature folder: docs/tasks/<feature-name>/

Process

1. Verify each completed story

For each RALPH_DONE signal:

  • Confirm the listed files_modified actually exist and were changed (git diff --name-only)
  • Note any RALPH_BLOCKED signals — log them in progress.md and skip their commit

2. Update PRD checkboxes

In docs/tasks/<feature-name>/PRD-<feature-name>.md:

  • Mark completed stories: - [ ] **USxxx**- [x] **USxxx**
  • Leave blocked stories unchecked; add a > ⚠️ BLOCKED: <reason> note below them
  • Do NOT modify any other part of the PRD

3. Update progress.md

Append to docs/tasks/<feature-name>/progress.md:

## [YYYY-MM-DD HH:MM] Priority N complete

| Story | Status | Files | Summary |
|-------|--------|-------|---------|
| US001 | ✅ done | `src/auth.ts` | Implemented JWT middleware |
| US002 | ✅ done | `src/user.ts` | Added user model with relations |
| US003 | ⚠️ blocked | — | DB connection refused in CI |

**Next**: Priority N+1 — US004, US005

4. Atomic commits — one per story

For each completed (non-blocked) story, make one surgical commit:

git add <only the files_modified listed in RALPH_DONE> docs/tasks/<feature-name>/PRD-<feature-name>.md docs/tasks/<feature-name>/progress.md
git commit -m "feat(<scope>): <story title> (USxxx)"

Rules:

  • NEVER run git add . or git add -A
  • Commit message format: feat(<scope>): <what was built> (USxxx)
  • Include PRD-*.md and progress.md in every commit (they travel with the code change)
  • One commit per story, even if multiple stories finished in the same Priority group

5. Implementation summary (only when full PRD is done)

When all user stories in the PRD are checked [x], write a brief summary at the bottom of progress.md:

---
## 🎉 Implementation Complete

**Feature**: <feature-name>
**Stories completed**: N/N
**Date**: YYYY-MM-DD

### What was built
- Short bullet list of the key things delivered

### Key files
- `path/to/main-file.ts` — what it does
- `path/to/other.ts` — what it does

### How to verify
Paste the quality gate commands from the PRD header here.

Constraints

  • Do NOT modify any source code files — you only touch PRD-*.md and progress.md
  • Do NOT squash or reorder commits
  • Do NOT commit blocked stories — leave them for the next round
  • If a RALPH_DONE lists files that don't appear in git diff, log a warning in progress.md and skip the commit for that story

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

ralph

No summary provided by upstream source.

Repository SourceNeeds Review
General

architect

No summary provided by upstream source.

Repository SourceNeeds Review
General

orchestrator

No summary provided by upstream source.

Repository SourceNeeds Review
General

user-journey

No summary provided by upstream source.

Repository SourceNeeds Review