implementation-document

An IMPLEMENTATION.md file documents implementation processes, setup instructions, scenario verification results, and deviations. You need one when your development project follows a DESIGN.md and requires formal, audit-friendly implementation documentation with standardized records.

To document deviations from design, use a standardized IMPLEMENTATION.md template that includes a dedicated Deviations from Design section. This captures changes from the original DESIGN.md, tracks the rationale, and preserves the reasoning for future reference and auditing.

A standardized implementation documentation template should include Setup Instructions, File Inventory, Deviations from Design, Git History, Dependencies, Scenario Verification, and Known Issues sections to ensure comprehensive, repeatable, and audit-friendly project records.

Create a repeatable workflow by applying a standardized IMPLEMENTATION.md template across all projects. This enforces consistent documentation of setup steps, verification results, and deviations, ensuring formal records are created, validated, and maintained uniformly.

This template is specifically applicable to development projects that follow a DESIGN.md file. While you can generate the IMPLEMENTATION.md independently, its Deviations from Design section is designed to formally capture and record changes made against an existing design document.

Record scenario verification results using the dedicated Scenario Verification section within the IMPLEMENTATION.md template. This ensures that testing outcomes and verification steps are formally documented alongside setup instructions, file inventory, and known issues.