Contents and workflow
10 promptsA how-to guide, verification steps, troubleshooting and references.
A quickstart, endpoint reference, error handling and example code.
A short announcement, detailed changelog and upgrade notes.
A bilingual glossary, usage rules, examples and open questions.
A short summary, main claims, evidence structure and comprehension questions.
An agenda summary, decision log, action table and confirmation list.
Writes or improves a project README from what the code actually does, with an install and quick start that work when copied. Use for a new project or a README that has drifted.
Writes an architecture overview of an existing system from its code and notes, covering context, components, boundaries, key decisions and trade-offs, with diagrams and short decision records.
Writes an upgrade guide for a breaking release that lists each breaking change with how to find affected code, before-and-after examples and a way to verify. Use when shipping a major version.
Writes a troubleshooting guide organised by symptom, with likely causes in order, diagnostic commands, fixes and when to escalate, from support tickets or issue threads.