Documenting Contracts
Use when documenting an HTTP API, message payloads, queue contracts, DTOs, file formats, or webhooks...
Works in any agent
2 static scans, 0 counted findings.
Recorded for this package revision; Edge checks the exact bundle again when your agent loads it.
What this skill does for you
Use when documenting an HTTP API, message payloads, queue contracts, DTOs, file formats, or webhooks - or when writing the api-reference of a legacy campaign, or when callers keep asking what a field means or which errors an endpoint returns. Encodes the four detail levels, the DTO-first catalog, wire types with source anchors, the generated-spec one-home rule, and omitted-versus-null semantics. Use whenever a machine interface needs documenting for its callers, even if nobody says "API docs".
Quoted from the skill description in the pinned sourceUse it with Edge
Set up Edge for me: read getedge.cc/SKILL.md and follow it. Then use Edge to load the documenting-contracts skill from riekelt/technical-writer.
Paste it into Claude, ChatGPT, Codex or Cursor.
Or read the skill source first.
Security evidence
| Scanner | Date | Result | Findings |
|---|---|---|---|
| Edge static checks | 2026-09-29 | Pass | 0 |
| Edge committed-secret checks | 2026-09-29 | Pass | 0 |
Static scans check the code, not how well the skill works.
Scanner scope, raw findings and mirrored provider records
Edge static checks (Edge-run): edge-static/1.0.0. Scope: Static patterns for remote execution, credentials with network sends, obfuscation, prompt overrides, hidden Unicode, binaries and persistence. Revision: 85e53729dd959a2795d593d6769068e342cf3486. Raw findings: not supplied. Counted findings: .
Edge committed-secret checks (Edge-run): edge-secrets/1.0.0. Scope: Credentials committed in the skill's files (values never shown). Revision: 85e53729dd959a2795d593d6769068e342cf3486. Raw findings: not supplied. Counted findings: .
Socket (skills.sh mirror): Version unavailable. Scope: Not supplied by the mirrored record. Revision: not supplied. Raw findings: not supplied. Counted findings: Not supplied.
Snyk (skills.sh mirror): Version unavailable. Scope: Not supplied by the mirrored record. Revision: not supplied. Raw findings: not supplied. Counted findings: Not supplied.
Source and licence
- Repository
- https://github.com/riekelt/technical-writer
- Pinned skill file
- View source at revision
- Revision
- 85e53729dd959a2795d593d6769068e342cf3486
- Package hash
- sha256:bd15b307ce0c8573340efaa0c43f443c8b5954a6323b98b68bd1b54b66e2078e
- Licence
- MIT
Files in the scanned package
| File | Size |
|---|---|
| SKILL.md | 6.3 KB |
Try Documenting Contracts in your agent.
Use when documenting an HTTP API, message payloads, queue contracts, DTOs, file formats, or webhooks...