c_Learn & Practice AILEARN/Document how the project really works
← Cookbook
COOKBOOK

Document how the project really works

Update the README for {{PROJECT_NAME}} using verified files and commands. Include setup, running, checks, configuration names without values, and known limitations.

Define the problem

Update the README for {{PROJECT_NAME}} using verified files and commands. Include setup, running, checks, configuration names without values, and known limitations.

Inspect prerequisites

Read project instructions and relevant configuration. Record the current state, use sample data, and confirm a recovery point.

Make a bounded plan

Identify the smallest change, its affected files, and a testable expected result. Keep publication separate.

Implement in small steps

Use the linked prompt with real project details. Review each stage before extending it. Preserve unrelated work.

Verify and debug

Follow the documented setup in a clean environment where possible; mark unverified steps.

Review and hand off

Inspect the diff and document changes, passed/failed/unrun checks, remaining limits, and recovery. Ask the owner to approve any live deployment.

Prompt library

GOAL:
Update the README for {{PROJECT_NAME}} using verified files and commands. Include setup, running, checks, configuration names without values, and known limitations.

CONTEXT / INPUT:
Project: {{PROJECT_NAME}}. Read relevant files and project instructions first. Ask only about material missing information.

SCOPE:
{{SCOPE}}

DO NOT:
Do not overwrite unrelated work, expose secrets, delete data, publish, or deploy. Respect {{CONSTRAINT}}.

EXPECTED OUTPUT:
A reviewable result with changed files or findings, and a concise explanation.

ACCEPTANCE CRITERIA:
{{SUCCESS_CRITERIA}}

VERIFY:
Follow the documented setup in a clean environment where possible; mark unverified steps.

REPORT:
Report changes, reasons, passed/failed/unrun checks, remaining limitations, and recovery steps. Never claim a check passed without evidence.

Common mistakes

Missing inputs, incorrect working folders, and unverified commands are common failure points. Stop at the failing step and gather evidence before trying again.

Before you run

Real projects
Esc · Close