daledesilva/obsidian_ink / .agents/skills/document
document
VerifiedDocument new or materially changed feature behavior implemented in the current chat thread.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 2.7 KB |
SKILL.md
View on GitHub---
name: document
description: Document new or materially changed feature behavior implemented in the current chat thread.
---
# Document current thread feature work
Document the new or materially changed feature behavior implemented in this chat thread.
Any text after `/document` is optional context — e.g. a feature name, task ID, or a hint about which part of the thread to document.
## Scope
- Document only behavior implemented or materially changed in the current chat thread.
- Use the current conversation, uncommitted changes, commits created in this thread, tests, and implementation code as sources of truth.
- Do not document unrelated branch history, speculative future behavior, or behavior you have not verified in code.
- If the current-thread feature scope is unclear, ask a clarifying question before editing docs.
## Steps
1. Gather evidence:
- Review the user's `/document` context and the current conversation.
- Run `git status`, `git diff`, `git diff --staged`, and `git log -10 --oneline` to identify changes from this thread.
- Inspect relevant implementation and tests directly before writing.
2. Choose documentation targets:
- Prefer existing docs under `docs/` that already describe the feature or interaction.
- Create a new focused doc page only when no existing page fits.
- Do not combine unrelated concepts into one doc page.
3. Update docs (follow `documentation-standards.md`):
- Choose **conceptual** vs **functional / playbook** mode from the page’s job.
- Conceptual: Conceptual understanding → Technical details → Technical Gotchas; Mermaid for non-trivial flows.
- Playbook: short intro → Setup → Procedures (`###` cases with Validating / steps / Confirm); `---` between major sections, `· · ·` between cases.
4. Add context comments:
- Add brief comments for feature intent, interaction rules, lifecycle ordering, persistence contracts, constraints, edge cases, and regression-sensitive decisions.
- Explain why functions, helpers, branches, and code snippets exist and why they are built a particular way.
- Default to adding a short comment when future maintainers would otherwise need thread history to preserve the behavior.
- Do not add comments that merely restate syntax or obvious assignments.
5. Verify:
- Re-read changed docs and comments for accuracy against the implementation.
- Do not run app install/launch steps for documentation-only changes.
- Do not commit unless the user also invokes `/commit`.
## Output
When done, show:
- Docs created or updated
- Context comments added
- Source evidence used (commits, diffs, tests, or files)
- Any behavior intentionally not documented because it was outside the current thread
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |