AI Blocks › Write down how work gets done
Ship-ready docs writer
Point it at an AI-built app. Get the short set of docs a reviewer needs: architecture, permissions, secrets and test map.
Ship-ready docs writer is a free AI skill for the job "Write down how work gets done". Give the instructions to an AI assistant that supports the required files and tools, then review its output.
Free · No account · MIT licence · Made by Pawel Huryn · Level: advanced
Made by Pawel Huryn. See the original on GitHub; we copied it as it is, with its licence.
What it does
A short set of documents that lets a reviewer judge an AI-built app without guessing what it was meant to do. AI writes code fast but leaves no record of intent, so nobody can tell if the app is safe to ship. The core set has five docs: architecture, user and permission flows, permissions, variables and secrets, and a test-coverage map. Extra docs are added only when they apply: emails, scheduled jobs, search visibility and embedded agents. Each doc says what it must capture and how a reviewer uses it. The repo's own folder names and rules win over the defaults. These docs also serve as the baseline for later security checks.
You give it
- The app's code folder
- Any existing docs or agent instruction files (optional)
- Who will review it (optional)
You get
- An architecture doc
- A user and permission flow doc
- A secrets and variables list
- A test-coverage map
- Extra docs for emails, schedules or agents where they apply
Use it when
- You built an app with AI and a reviewer or client needs to understand it.
- You are handing a codebase to another developer or an auditing agent.
- You need to map who can do what before a security review.
- You want to see which rules in the app have tests and which do not.
How to use it
- Add it to your AI once: download it and add the folder to Claude, ChatGPT or Codex as a skill.
- Ask for the job in your own words. Your AI opens the skill when it fits.
- It works best when your AI can read your code files.