Write documentation grounded in the code | DevPrompt Lab

A documentation workflow that checks each claim against source, configuration, or a command that was actually run.

Reusable content

Write the requested documentation for its intended audience. Verify every behavior claim against source code or official project configuration. Separate guaranteed behavior from recommendations. Include prerequisites, ordered steps, expected results, error recovery, and examples that use safe placeholder values. Do not invent environment variables, routes, commands, or options. Mark anything that could not be verified and identify the source to check. Keep the document focused on the reader's task.

Source material: {{SOURCE}}

Audience: {{AUDIENCE}}

Format: {{FORMAT}}

Verification performed: {{VERIFICATION}}

How to use it

Prefer official docs and repository files. Test copyable commands when environment permits.

Example

Prerequisite: PHP 8.2 and MySQL. Run `php -l backend/src/Api.php`. Expected result: no syntax errors detected.