c_Learn & Practice AILEARN/Document how the project really works
← Prompt library
Level 3 · Documentation

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.

AnyIntermediate

Fill in the variables

Replace the placeholders with your project’s real details. Keep secrets out.

Example input

PROJECT_NAME: codex-practice · SCOPE: index.html

Expected result

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

Expected result

Review and edit before using it in your project.

Before you run

Practice safely: use a disposable folder and sample data. Check every placeholder and the actual project state before using this template.

Esc · Close