Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions AGENTS.md.example
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AGENTS.md will surely give us tool independence, but can we think about moving the entire AI-DLC steering as part of AGENTS.md as a separate feature? I think we also discussed there are other issues around AGENTS.md that if the user already has an AGENTS.md then how this will be merged into their existing file,

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will raise an issue that we will use as a guiding principle for this work.
We need to adhere to the current rule mechanism and not introduce new concepts (AUDIT etc) as a part of this.
Also for this feature PR lets just work out of a branch and not use the fork mechanism.
The code needs to be rebased before raising a PR.
Please have a look at file specific comments @raj-jain-aws

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just an example configuration file, that is not necessary, as you see it has .example as ending. However if you want to control the folder structure of the multi-user feature, it is necessary to configure them somewhere. I don't want the users to mess about with the core rules so the ideal file for this is AGENTS.md as it's read automatically by the ai-assistant and such can contain global variables.

Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# AGENTS.md - Project Configuration

Copy to project root as `AGENTS.md` to customize multi-user behavior.

## Folder Structure

### Generated Code
```
[unit-name]/
β”œβ”€β”€ src/ # Source code (language-specific structure)
β”œβ”€β”€ tests/ # Tests
└── docs/ # Documentation
```

### Audits
```
aidlc-docs/audits/[unit-name]/[developer]/
```

### Branches
```
feature/[unit-name]-[developer]
```

## Custom Paths (Optional)

Override defaults by specifying:
- `code_root`: Base path for generated code (default: `[unit-name]/`)
- `audit_root`: Base path for audits (default: `aidlc-docs/audits/`)
- `branch_prefix`: Branch naming prefix (default: `feature/`)
152 changes: 152 additions & 0 deletions QUICK-REFERENCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
# AI-DLC Multi-User Quick Reference

## πŸš€ Quick Start

### Lead Developer
```bash
kiro-cli chat "Create [your project description]"
# Complete inception β†’ Choose Option B
```

### Team Members
```bash
git pull origin main
kiro-cli chat "claim unit <unit-name>"
# Work on unit β†’ Complete
kiro-cli chat "complete unit <unit-name>"
```

### Integrator
```bash
kiro-cli chat "consolidate units"
```

## πŸ“‹ Commands

| Command | What It Does |
|---------|--------------|
| `list units` | Show all units and status |
| `claim unit <name>` | Start working on a unit |
| `complete unit <name>` | Finish your unit |
| `merge unit <name>` | Merge unit to main |
| `consolidate units` | Merge all units |
| `unit status <name>` | Check unit details |
| `show audit` | Your activity log |
| `show all audits` | Team activity logs |

## 🌳 Branch Structure

```
main # Shared inception artifacts
β”œβ”€β”€ unit/user-service-alice # Alice's work
β”œβ”€β”€ unit/auth-service-bob # Bob's work
└── unit/api-gateway-charlie # Charlie's work
```

## πŸ“ File Structure

```
aidlc-docs/
β”œβ”€β”€ audit/
β”‚ β”œβ”€β”€ user-alice-audit.md # Alice's log
β”‚ β”œβ”€β”€ user-bob-audit.md # Bob's log
β”‚ └── audit-index.md # All logs
β”œβ”€β”€ construction/
β”‚ β”œβ”€β”€ unit-assignments.md # Who's doing what
β”‚ └── consolidated-index.md # Merged units
```

## πŸ”„ Workflow

```
Inception (Lead) β†’ Units Generated
↓
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
↓ ↓ ↓
Alice (Unit 1) Bob (Unit 2) Charlie (Unit 3)
↓ ↓ ↓
Complete Complete Complete
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
↓
Consolidate
↓
Build & Test
```

## βœ… Status Icons

- βœ… Completed
- πŸ”„ In Progress
- ⭐ Available
- ⏳ Blocked (waiting on dependency)

## 🎯 Best Practices

1. **Check dependencies** before claiming units
2. **Commit often** in your unit branch
3. **Complete units** when all stages done
4. **Consolidate regularly** to avoid drift
5. **Review audits** for team coordination

## πŸ†˜ Quick Fixes

**Branch exists?**
```bash
git branch -D unit/name-user
kiro-cli chat "claim unit name"
```

**Out of sync?**
```bash
git pull origin main
kiro-cli chat "list units"
```

**Check status?**
```bash
kiro-cli chat "unit status <name>"
```

## πŸ“ž Need Help?

```bash
kiro-cli chat "show all audits" # See what everyone did
kiro-cli chat "list units" # See current status
cat aidlc-docs/construction/unit-assignments.md
```

## πŸŽ“ Example Session

```bash
# Alice starts project
kiro-cli chat "Create e-commerce API"
# β†’ Completes inception, enables team

# Bob joins
git pull origin main
kiro-cli chat "claim unit product-catalog"
# β†’ Works on unit
kiro-cli chat "complete unit product-catalog"

# Charlie joins
git pull origin main
kiro-cli chat "claim unit shopping-cart"
# β†’ Works on unit
kiro-cli chat "complete unit shopping-cart"

# Alice consolidates
kiro-cli chat "consolidate units"
# β†’ All units merged, build & test starts
```

## πŸ’‘ Pro Tips

- Use `kiro-cli chat "I want to work on X"` instead of `claim unit X`
- Use `kiro-cli chat "I'm done with X"` instead of `complete unit X`
- Use `kiro-cli chat "what's available?"` instead of `list units`
- AI understands natural language!

---

**Full Guide**: See `MULTI-USER-GUIDE.md`
**Implementation Details**: See `MULTI-USER-IMPLEMENTATION.md`
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,52 @@ AI-DLC follows a structured three-phase approach that adapts to your project's c
- **Risk-Based**: Complex changes get comprehensive treatment, simple changes stay efficient
- **Question-Driven**: Structured multiple-choice questions in files, not chat
- **Always in Control**: Review execution plans and approve each phase
- **Multi-User Parallel Development**: Multiple developers can work on different units simultaneously with automatic branch management and audit isolation

## Project Configuration

### AGENTS.md (Optional)

Customize multi-user behavior and folder structure by creating an `AGENTS.md` file in your project root:

```bash
cp $AIDLC_WORKFLOWS/AGENTS.md.example ./AGENTS.md
```

This file allows you to configure:
- Generated code folder structure per unit
- Audit file locations
- Branch naming conventions
- Custom paths for your project

See [AGENTS.md.example](AGENTS.md.example) for details.

## Multi-User Parallel Development

AI-DLC includes built-in team collaboration with automatic workflow management:

- πŸ”€ **Automatic Branch Creation**: Each developer works in isolated branches
- πŸ“ **User-Scoped Audits**: No audit file conflicts between team members
- 🎯 **Unit Assignment Tracking**: Clear visibility of who's working on what
- πŸ”„ **Dependency-Aware Consolidation**: Automatic merging in correct order
- πŸ“Š **Consolidated Views**: Project-wide visibility with automatic indexing

**Quick Start**:
```bash
# Lead completes inception
kiro-cli chat "Create microservices architecture"
# β†’ Choose "Enable team collaboration"

# Team members claim units
kiro-cli chat "claim unit user-service"

# Integrator consolidates
kiro-cli chat "consolidate units"
```

Multi-user functionality is automatically available when using AI-DLC - no additional setup required.

**Learn More**: See [Quick Reference](QUICK-REFERENCE.md) for commands and workflows

## Prerequisites

Expand Down
Loading