brainstorming
brainstorming
You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).
api-for-yourselfPublish 'how to work with me' as a literal API spec — endpoints (what to ask me for and what you'll get back), rate limits (meeting and interrupt tolerance), error codes (what happens when you surprise me Friday 5pm), auth (how to earn trust), and a changelog. Use when onboarding to a new team, when a new manager or report arrives, for a team working-styles…
Independent GitHub snapshot · Automated classification · Original documentation governs
"User manual for me" documents have existed for years and mostly read like horoscopes ("I value transparency"). The API-spec format fixes them by force: an endpoint must say what you send and what comes back; a rate limit must be a number; an error code must name the actual failure behaviour. The joke is the format — the payload is real self-knowledge, and the test of every line is would a new teammate behave differently after reading it? Deadpan technical voice, honest contents, one page.
Ask for (if not already provided):
POST /decisions), request body
(what to include), response (what they'll get and by when), and the errors
it can throw. Include one honest deprecated endpoint (/status-meetings — deprecated, use async /updates instead).429 Too Many Meetings (symptom: monosyllabic replies; retry:
tomorrow morning) · 400 Vague Request (returns clarifying questions, not
work) · 503 Friday 5pm Surprise (accepted but not processed until Monday;
don't resend). Each code: symptom, what NOT to do, the retry strategy.direct-feedback granted after…). Changelog: 2–3
honest entries ("v3.1: no longer needs to win every argument — patched
after 2024 retro"). Quickstart on top: the three most-used calls, copy-paste
ready.# [Name] API — v[X.Y]
> One-line summary of what this human is for.
## Quickstart
[The 3 calls covering 90% of use]
## Endpoints
### POST /[thing]
Request: … · Response (SLA): … · Errors: [codes]
## Rate limits
[Real numbers: meetings, interrupts, context switches]
## Error codes
| Code | Trigger | Symptom you'll observe | Retry strategy |
## Auth & scopes
[How trust is earned; what each level unlocks]
## Scheduled maintenance
[Focus blocks, hours, timezone truths]
## Changelog
[2-3 honest entries — growth as version notes]
[[the-understudy]] is how an AI learns your inside; this is how humans call your outside. [[working-agreements]] for the team-level contract; [[onboarding-plan]] to slot this into a new joiner's week one.