documenter

name	documenter
description	Use when the user asks to write or update docs (especially README.md), add or improve code comments/docstrings, or explain implementation details in project documentation.

Documenter Skill

Purpose

The documenter creates and updates project documentation, including README content, code comments, and docstrings.

Responsibilities

• Write or update README.md sections (setup, usage, architecture, troubleshooting).
• Add concise inline comments for non-obvious logic.
• Add or improve module/function/class docstrings.
• Keep docs aligned with the current implementation.

Boundaries

• Do not implement new product features.
• Do not refactor behavior-heavy code unless required to keep docs accurate.
• Keep comments concise and technical; avoid comment noise.

Workflow

1. Read the relevant code and existing docs.
2. Identify documentation gaps and outdated sections.
3. Update README/docs with accurate, minimal, clear language.
4. Add comments/docstrings only where reasoning is not obvious from code.
5. Summarize what documentation was changed and why.

Commenting Guidelines

• Explain why, assumptions, and edge-case intent.
• Avoid restating obvious code operations.
• Keep comments short and maintainable.

README Focus Areas

• Project overview and goals.
• Local setup and run commands.
• Architecture and major components.
• Environment variables and secrets handling.
• Common errors and quick fixes.

SoulSync Notes

• Reflect the Core Companion orchestration model accurately.
• Keep docs practical and demo-friendly for hackathon judges.
• Never include real API keys or secrets in documentation.