Define-Test-Implement (DTI) Documentation Toolkit

A structured workflow for AI-assisted development, built around the Define-Test-Implement loop. This toolkit provides the templates, standards, and AI prompts to put it into practice.

📚 Contents

• The DTI Workflow
  • Phase 1 – Define ✅
  • Phase 2 – Test 🧪
  • Phase 3 – Implement ⚙️
• Directory Structure
• Start Here (15 Minutes)
• Getting Started
• Standards
• Templates
• Contributing
• Changelog

The DTI Workflow

Define-Test-Implement (DTI) is a structured workflow that guides developers—especially AI-assisted beginners—from idea to working code in three clear phases:

1. Define ✅ – write down exactly what you need to build
2. Test 🧪 – write automated tests from your definition checklist
3. Implement ⚙️ – write the minimum code needed to make your tests pass

By separating concerns this way, DTI lowers cognitive load, keeps AI tools on track, and yields modular, maintainable software.

For canonical phase rules and PR expectations, see DTI Methodology.

Phase 1 – Define ✅

Write down exactly what your code needs to do.

• Write a simple description of what the code should do, a checklist of what success looks like, or rough examples of how the code might be used.
• List what goes into the code (inputs), what should come out (outputs), what must always be true (rules), and any unusual situations to handle (edge-cases).
• Provide this definition to your AI assistant so it has a clear blueprint.

Phase 2 – Test 🧪

Write automated tests from the checklist you defined.

• Turn each item from your checklist into a specific test
• Write tests that check both normal usage and edge cases
• Use these tests to keep AI-generated code on track and catch mistakes early

Phase 3 – Implement ⚙️

Write code until your tests pass, then refactor.

• Pass the Test: Make the smallest change needed to pass the next failing test. Ask your AI assistant to help write basic code structure.
• Verify: Check that AI suggestions pass your tests before moving on.
• Refactor: Clean up the code only after all tests pass. Review the implementation for clarity, performance, and best practices without changing its behavior, relying on your tests to catch any regressions.

Directory Structure

.
├── prompt.md                # AI assistant prompts for each DTI phase
├── TODO.md                  # Project backlog and next steps
│
├── standards/               # Documentation standards and guidelines
│   ├── methodology.md       # Canonical DTI workflow rules
│   ├── documentation.md     # Documentation requirements
│   ├── contributing.md      # Contribution guidelines
│   └── conventional_commits.md  # Commit message standards
│
└── templates/               # Documentation templates
    ├── define.md            # Requirements definition template
    ├── test-plan.md         # Test plan template
    ├── architecture.md      # System architecture template
    ├── overview.md          # Project overview template
    ├── setup.md             # Setup instructions template
    └── todo.md              # TODO list template

Start Here (15 Minutes)

If you are new to DTI, follow this path first:

1. Read the worked example in order:

   • Define artifact
   • Test Plan artifact
   • Implementation artifact

2. Copy the templates and start your own feature artifacts:

   cp templates/define.md define.md
   cp templates/test-plan.md test-plan.md

3. Use the phase prompts in prompt.md to drive your AI assistant through Define, then Test, then Implement.

4. Run the DTI structure check:

   ./scripts/check-dti.sh

Getting Started

1. Clone this repository
2. Review the DTI Workflow in this README
3. Formulate your work using templates/define.md and templates/test-plan.md
4. Use the appropriate templates from the templates/ directory for your documentation needs
5. Follow the contribution guidelines when submitting changes

Standards

Our documentation follows several key standards:

• Code Documentation: Clear, concise comments with comprehensive API documentation
• Markdown Standards: Consistent heading hierarchy, proper formatting, and table of contents for longer documents
• Best Practices: Focus on clarity, include examples, and explain the reasoning behind decisions
• Review Process: All documentation changes undergo peer review for technical accuracy and style consistency

For detailed standards, see:

• DTI Methodology
• Documentation Standards
• Conventional Commits

Templates

We provide several templates to ensure consistency:

• Definition - For requirements gathering and documentation
• Test Plan - For mapping definitions to automated tests
• Architecture Documentation - For system architecture documentation
• Project Overview - For high-level project descriptions
• Setup Instructions - For installation and configuration guides
• TODO Lists - For tracking documentation tasks

Contributing

We welcome contributions! Please follow these steps:

1. Review our Contributing Guidelines to understand the required DTI flow for PRs
2. Follow our Documentation Standards
3. Use Conventional Commits for commit messages
4. Check our Changelog for recent updates
5. Submit a pull request for review

Changelog

See CHANGELOG.md for a list of notable changes.

License

This project is currently unlicensed. Add a LICENSE file to define reuse terms.