npm package: @ismhac/create-agent-kit
Description: Install .github/ agent workflow kit into your repo
Latest version: 1.0.4

# 🤖 AI Dev Kit

A stack-agnostic, AI-assisted development kit for software teams using
GitHub Copilot. Provides a complete set of agents, skills, prompts,
and document templates to standardize how your team plans, builds,
and ships software — with AI as a first-class collaborator.

---

## What's in this kit?

| Layer | Contents | Purpose |
|---|---|---|
| **AI Core** | `copilot-instructions.md` | Global AI behavior rules for the workspace |
| **Agents** | `agents/*.agent.md` | Role-based AI personas (Analyst, Architect, Developer, DevOps, PO, QA, Scrum Master) |
| **Skills** | `skills/*/SKILL.md` | Step-by-step process guides for structured tasks |
| **Prompts** | `prompts/*.prompt.md` | Reusable prompts invokable via slash commands |
| **Doc Templates** | `docs/*.md` | Project documentation templates ready to fill in |
| **GitHub Templates** | `ISSUE_TEMPLATE/`, `pull_request_template.md` | Standardized issue and PR workflows |

---

## Quickstart

### 1. Use this template

```bash
# Clone or use as GitHub template
git clone https://github.com/your-org/ai-dev-kit.git my-project
cd my-project
```

### 2. Configure the workspace

Open `.github/copilot-instructions.md` and fill in all `TODO` markers:

```markdown
- Project name
- Short description
- Primary users
- Current phase
- Tech stack (brief)
- Key constraints
```

### 3. Generate your project docs

Ask Copilot to create your project-specific docs from templates:

```
@workspace Using docs/tech-stack.md as template, create docs/project/tech-stack.md for our project. We are building [brief description] using [tech stack].
```

Repeat for each doc in `docs/` — output always goes to `docs/project/`.

### 4. Activate agents

Invoke agents by referencing their file in chat:

```
@workspace #analyst Analyze this requirement: [paste raw brief]
```

```
@workspace #architect Design the authentication system based on docs/project/prd.md
```

### 5. Use skills and prompts

Skills are invoked contextually by agents. Prompts are available as slash commands:

```
#ask-clarifying-questions
#summarize-context
#validate-output
#request-review
```

---

## Folder Structure

```
.
├── README.md                          # This file
├── .gitignore                         # Universal ignore patterns
├── .editorconfig                      # Editor formatting baseline
│
├── .github/
│   ├── copilot-instructions.md        # ← Fill this in first
│   │
│   ├── prompts/                       # Reusable slash-command prompts
│   │   ├── ask-clarifying-questions.prompt.md
│   │   ├── summarize-context.prompt.md
│   │   ├── validate-output.prompt.md
│   │   └── request-review.prompt.md
│   │
│   ├── ISSUE_TEMPLATE/                # GitHub issue templates
│   │   ├── user-story.md
│   │   ├── bug-report.md
│   │   └── tech-decision.md
│   │
│   ├── pull_request_template.md       # PR template
│   │
│   ├── agents/                        # AI agent definitions
│   │   ├── analyst.agent.md
│   │   ├── architect.agent.md
│   │   ├── developer.agent.md
│   │   ├── devops.agent.md
│   │   ├── po.agent.md
│   │   ├── qa.agent.md
│   │   └── scrum-master.agent.md
│   │
│   └── skills/                        # Structured task guides
│       ├── analyze-requirements/
│       ├── create-architecture/
│       ├── create-pipeline/
│       ├── create-prd/
│       ├── create-story/
│       ├── create-docs/
│       ├── debug-issue/
│       ├── estimate-effort/
│       ├── manage-backlog/
│       ├── refactor-code/
│       ├── review-code/
│       ├── write-code/
│       └── write-tests/
│
└── docs/
    ├── _template.md                   # Base template for all docs
    ├── conventions.md                 # → copy to docs/project/
    ├── tech-stack.md                  # → copy to docs/project/
    ├── workflow.md                    # → copy to docs/project/
    ├── definition-of-ready.md         # → copy to docs/project/
    ├── definition-of-done.md          # → copy to docs/project/
    ├── prd.md                         # → copy to docs/project/
    ├── architecture.md                # → copy to docs/project/
    ├── backlog.md                     # → copy to docs/project/
    ├── project/                       # ← your live project docs go here
    └── stories/                       # ← your user stories go here
```

---

## Agents

Seven role-based agents, each with a defined scope, workflow, and output format:

| Agent | File | Invoke when... |
|---|---|---|
| **Analyst** | `agents/analyst.agent.md` | Raw requirements need structuring |
| **Architect** | `agents/architect.agent.md` | System design or tech decisions needed |
| **Developer** | `agents/developer.agent.md` | Implementing, debugging, or refactoring code |
| **DevOps** | `agents/devops.agent.md` | CI/CD, infrastructure, or deployments |
| **Product Owner** | `agents/po.agent.md` | PRD, stories, or backlog management |
| **QA** | `agents/qa.agent.md` | Test strategy, writing tests, or validating work |
| **Scrum Master** | `agents/scrum-master.agent.md` | Sprint planning, estimation, or impediments |

---

## Template Rules

All files in `docs/` are **read-only templates** — identified by `template: true` in their frontmatter.

| Rule | Detail |
|---|---|
| Never edit template files directly | They are the source of truth for the kit |
| Always create output in `docs/project/` | Agents write live docs here, not in `docs/` |
| Stories go in `docs/stories/` | Format: `<story-id>-<slug>.md` |

---

## Workflow Overview

```
Idea / Request
    │
    ▼
Analyst ──────→ structured requirements
    │
    ▼
Product Owner ─→ PRD + user stories
    │
    ▼
Architect ─────→ system design + tech decisions
    │
    ▼
Scrum Master ──→ sprint planning + backlog
    │
    ▼
Developer ─────→ implementation + tests
    │
    ▼
QA ────────────→ validation + sign-off
    │
    ▼
DevOps ────────→ CI/CD + deployment
```

---

## Prerequisites

- **GitHub Copilot** with Agent Mode enabled (VS Code or GitHub.com)
- **VS Code** recommended — full support for prompt files, agent mode, and `copilot-instructions.md`
- No specific language or framework required — this kit is stack-agnostic

---

## Setup Checklist

Use this checklist when adopting the kit for a new project:

- [ ] Fill in `TODO` markers in `.github/copilot-instructions.md`
- [ ] Create `docs/project/tech-stack.md` from template
- [ ] Create `docs/project/conventions.md` from template
- [ ] Create `docs/project/workflow.md` from template
- [ ] Create `docs/project/definition-of-ready.md` from template
- [ ] Create `docs/project/definition-of-done.md` from template
- [ ] Update `.gitignore` with project-specific patterns
- [ ] Update `.editorconfig` with language-specific overrides if needed
- [ ] Verify Copilot Agent Mode is enabled in VS Code settings
- [ ] Test with: `@workspace What agents are available in this kit?`

---

## Contributing to the Kit

To improve the kit itself (not a project using the kit):

- All changes to template files must be backward compatible
- Add a `Changelog` entry to affected files
- Test changes by creating a sample project doc from the updated template
- PRs to the kit follow the same `.github/pull_request_template.md`

---

## License

<!-- TODO: Add license -->