Workflows

Workflows are standardized processes that help automate and guide software development steps when working with AI agents. AIDK's workflows are located in the .agent/workflows/ directory (or specific to your IDE). You can invoke them using slash commands (e.g., /new-requirement, /execute-plan).

Main Flow: /new-requirement

/new-requirement is the core workflow for scaffolding and managing documentation for a new feature. This process guarantees that a feature is thoroughly analyzed, designed, and planned before any code is written.

Objectives

• Standardized Documentation: Ensure all features are properly documented from requirements to planning.
• Minimize Errors: The AI rigorously analyzes requirements before proposing architecture and implementation steps.
• Traceability: Each feature receives its own isolated documentation scope, making cross-checking straightforward.

Steps in /new-requirement

1. Capture Requirement The AI asks for fundamental information: feature name (kebab-case, e.g., user-authentication), the problem it solves, the target users, and key user stories.

2. Create Feature Documentation Structure AIDK duplicates templated files to create a feature-specific documentation suite:

   • docs/ai/requirements/feature-{name}.md
   • docs/ai/design/feature-{name}.md
   • docs/ai/planning/feature-{name}.md
   • docs/ai/implementation/feature-{name}.md
   • docs/ai/testing/feature-{name}.md

3. Requirements Phase The AI populates docs/ai/requirements/feature-{name}.md with: the problem statement, goals/non-goals, user stories, success criteria, constraints, and open questions.

4. Design Phase The AI drafts docs/ai/design/feature-{name}.md covering: architectural changes, data models, APIs/interfaces, components, design decisions, and security/performance considerations.

5. Planning Phase The AI outlines the execution inside docs/ai/planning/feature-{name}.md via: task breakdown with subtasks, dependencies, effort estimates, implementation ordering, and risks.

6. Documentation Review The AI automatically triggers /review-requirements, /review-design and /review-implementation to validate the drafted documentation.

7. Next Steps This command solely focuses on planning and documentation. Once ready for coding, you will use /execute-plan to have the AI implement the tasks defined.

Other Essential Workflows

Beyond /new-requirement, AIDK offers a robust workflow ecosystem:

Slash Command	Purpose
/execute-plan	Execute the established feature plan task by task.
/debug	Deep root-cause analysis before applying code changes.
/code-review	Thorough pre-push code review validating against design.
/write-tests	Add tests to ensure the reliability of a new feature.
/update-docs	Synchronize README files and Docusaurus sites with the latest changes.
/check-implementation	Compare the written code against the design and requirements.