AI-DLC Documentation Index

Start here — reading order and document map

AI-DLC Documentation Index

This directory contains the project-specific AI-DLC artifacts for the ai-dlc-game application.

Purpose

Use this directory to understand how the project was planned, designed, implemented, reviewed, and documented using the AI-Driven Development Life Cycle.

This documentation is intentionally split into two layers:

  • Project artifacts: aidlc-docs/
  • Shared methodology and rule set: aidlc-rules/

What AI-DLC Means in This Repository

AI-DLC is an adaptive development methodology with three lifecycle phases:

  • Inception

    • Defines what should be built and why
    • Covers requirements, planning, application design, and unit decomposition
  • Construction

    • Defines how the solution should be built
    • Covers detailed design, code generation, and build/test preparation
  • Operations

    • Covers how the work is made visible, understandable, and maintainable over time
    • In this repository it includes public documentation and artifact visibility guidance

Start Here

If you are new to this repository, read these files in order:

  1. aidlc-docs/aidlc-state.md
  2. aidlc-docs/inception/requirements/requirements.md
  3. aidlc-docs/inception/plans/execution-plan.md
  4. aidlc-docs/inception/application-design/application-design.md
  5. aidlc-docs/how-aidlc-works.md
  6. aidlc-rules/README.md

Directory Map

Project state and traceability

  • aidlc-state.md

    • Workflow progress snapshot
    • Phase completion tracking
    • Extension enablement summary
  • audit.md

    • Audit trail of major AI-DLC interactions and decisions

Inception artifacts

  • inception/requirements/

    • Request analysis, requirement questions, and approved requirements
  • inception/plans/

    • Execution planning and stage selection rationale
  • inception/application-design/

    • Architecture, components, services, and unit-of-work artifacts

Construction artifacts

  • construction/plans/
    • Functional design, NFR, and code-generation planning artifacts

Operations artifacts

  • operations/deployment-guide.md

    • Public visibility and publication guidance for AI-DLC materials
  • how-aidlc-works.md

    • Reader-friendly explanation of how the AI-DLC methodology works in this app

How to Read These Documents Correctly

Some AI-DLC artifacts capture planning intent at the time they were generated. The implementation in the source tree may evolve after those documents were written.

Use the following precedence when there is a mismatch:

  1. Running application behavior
  2. Source code in the workspace root
  3. AI-DLC planning and design artifacts in this directory

That makes these documents valuable for understanding decisions and methodology, while the codebase remains the operational source of truth.

Key Files for This App

For this snake game specifically, the most useful artifacts are:

  • README.md
  • how-aidlc-works.md
  • inception/requirements/requirements.md
  • inception/plans/execution-plan.md
  • inception/application-design/application-design.md
  • construction/plans/nokia-snake-game-code-generation-plan.md
  • aidlc-state.md
  • audit.md

Relationship to aidlc-rules

aidlc-docs explains what happened in this project.

aidlc-rules explains the reusable methodology, constraints, and workflow rules that shaped those project artifacts.

Read aidlc-rules/README.md if you want to understand the general AI-DLC process beyond this single application.

Public Visibility

This repository also publishes public copies of both aidlc-docs and aidlc-rules within the application so end users and collaborators can browse the generated project documents and the methodology rules directly.

The public entry points are:

  • /ai-dlc/ for the methodology overview
  • /aidlc-docs/ for the published project artifact set
  • /aidlc-rules/ for the published AI-DLC rule set