document

Included with Lifetime

$97 forever

Use to generate documentation — code reference, user manual, architecture, technical deep-dive. Output shape varies by document type. Pulls from code + tests + memory for accuracy.

General

What this skill does


# document

Generate docs. Doc-type-aware — architecture vs API ref vs user manual have different shapes.

## Document types

| Type | Audience | Shape |
|---|---|---|
| `architecture` | senior engineers, new hires | system overview, component map, data flow, design decisions |
| `api` | API consumers | endpoint table, request/response, errors, examples, auth |
| `user-manual` | end users | task-oriented (how to X), screenshots, troubleshooting |
| `technical` | engineers maintaining the code | module-by-module deep dive, conventions, pitfalls |
| `runbook` | on-call / SRE | symptoms → diagnosis → fix, escalation paths |
| `migration` | engineers upgrading | breaking changes, before/after, gotchas |

## Method

1. **Pick type** (or detect from prompt).
2. **Source pass:**
   - Architecture: `Explore` + `reverse-prompt` skill for high-level
   - API: codegen output + tests for examples
   - User manual: feature inventory + UI screens
   - Technical: per-module read + test names
   - Runbook: incident memory (`mem_search { kind: incident }`)
   - Migration: changelog + breaking-change tags
3. **Write.** Doc-type-specific structure.
4. **Cite.** Every claim links to source (file:line, commit, memory id).
5. **Verify.** Read the doc as the audience. Does it answer the questions they'd ask?

## Output shape (architecture example)

```
# <System> Architecture

## Overview
<one paragraph>

## Components
- <name> (<file>) — <responsibility>
- ...

## Data flow
<diagram or numbered sequence>

## Design decisions
- D1: <decision> — <rationale> — <alternatives considered>
- ...

## Extension points
- <how to add a new X>

## References
- <file:line>
- <memory id>
```

## Rules

- **Cite everything.** Claim without citation = fiction.
- **Audience-first.** Write for the named audience; don't mix levels.
- **Diagrams in Mermaid** where helpful (Markdown-renders, source-controlled).
- **Examples are runnable.** API doc examples should work copy-paste.
- **No "TODO" placeholders in shipped doc.**

## Anti-patterns

- README that's actually 3 docs jammed together
- API ref that says "coming soon"
- User manual that assumes engineering knowledge
- Architecture doc that's outdated (verify with `/codemap-trust`)

## When NOT to use

- One-line edit — inline comment suffices
- Generated doc (e.g. typedoc, swagger-ui) — let codegen do it

## Subagent dispatch

- `documenter` agent
- `Explore` for source pass
- `Bash` (Mermaid CLI) if diagrams need rendering

## Value over native CC

CC will write docs. CC won't naturally enforce doc-type-specific shapes, citation discipline, or audience matching. The structure IS the value.

Files: 1

Size: 2.8 KB

Complexity: 6/100

Category: General

Source: https://github.com/ialameh/sift-coder/tree/main/skills/docs/document

Related in General

modeling-omnistudio-epc-catalog

Included

Salesforce Industries CME EPC product-modeling skill for Product2-based catalog creation. Use when creating EPC products, configuring product attributes, building offer bundles with Product Child Items, or reviewing EPC DataPack JSON metadata for product catalog changes. TRIGGER when: user creates or updates Product2 EPC records, AttributeAssignment payloads, AttributeMetadata/AttributeDefaultValues, Offer bundles, or ProductChildItem relationships. DO NOT TRIGGER when: designing OmniScripts/FlexCards/Integration Procedures (use building-omnistudio-omniscript, building-omnistudio-flexcard, or building-omnistudio-integration-procedure), implementing Apex business logic (use generating-apex), or troubleshooting deployment pipelines (use deploying-metadata).

Generalscripts

relationship-science-coach

Included

Use this skill for direct, practical adult relationship coaching: couples conflict, repair, trust, marriage, dating, flirting, attachment patterns, emotional connection, sex, desire differences, eroticism, kink negotiation, affection, love languages, breakups, and long-term passion. Draw on Gottman, EFT and Hold Me Tight, attachment science, modern sex research, Perel, Nagoski, Kerner, Schnarch, Love and Stosny, and flexible love-language tools. Be concrete and low-hedge. Redirect only for imminent danger, abuse, coercive control, minors, non-consent, self-harm, stalking, or medical/legal/psychiatric decisions.

Generalscripts

building-sf-integrations

Included

Salesforce integration architecture and runtime plumbing with 120-point scoring. Use this skill to set up Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, and Change Data Capture. TRIGGER when: user sets up Named Credentials, External Services, REST/SOAP callouts, Platform Events, CDC, or touches .namedCredential-meta.xml files. DO NOT TRIGGER when: Connected App/OAuth config (use configuring-connected-apps), Apex-only logic (use generating-apex), or data import/export (use handling-sf-data).

Generalscripts

venue-templates

Included

Access comprehensive LaTeX templates, formatting requirements, and submission guidelines for major scientific publication venues (Nature, Science, PLOS, IEEE, ACM), academic conferences (NeurIPS, ICML, CVPR, CHI), research posters, and grant proposals (NSF, NIH, DOE, DARPA). This skill should be used when preparing manuscripts for journal submission, conference papers, research posters, or grant proposals and need venue-specific formatting requirements and templates.

Generalscripts

let-fate-decide

Included

Draws the 12 Houses of the Zodiac Tarot spread to inject entropy into planning when prompts are vague, ambiguous, or casually delegated. Interprets the spread to guide next steps. Use when the user says 'let fate decide', 'YOLO', 'whatever', 'idk', or other nonchalant phrases, makes Yu-Gi-Oh references, or when you are about to arbitrarily pick between multiple reasonable approaches. Prefer over ask-questions-if-underspecified when the user's tone is casual or playful rather than precision-seeking.

Generalscripts

net-ops

Included

Cross-platform network troubleshooting (Windows, macOS, Linux) via local or remote shell. Use for: DNS broken, can't resolve hostnames, nslookup/dig works but apps fail, NRPT, WFP, scutil, /etc/resolver, systemd-resolved, /etc/resolv.conf, NetworkManager, VPN DNS leak residue (ProtonVPN/Mullvad/WireGuard/AnyConnect), AV/firewall blocking DNS or DoH, Tailscale DNS interaction, intermittent connectivity, remote diagnostics over SSH.

Generalscripts