# ASDM Workspace Installation Guide

## Overview

This document provides instructions for installing and setting up the ASDM (AI-assisted Software Development Methodology) workspace. The ASDM workspace provides a collection of toolsets that enable AI-assisted software development workflows, including context building, PRD planning, prototyping, and basic git operations.

## AI Guided Installation

To install all ASDM toolsets using AI Guided Installation, copy and paste the following prompt into your AI Coding tool's chat window:

```shell
Follow instructions in .workspace/INSTALL.md
```

## Prerequisites

- An AI coding assistant (Claude Code, GitHub Copilot, or Tencent CodeBuddy)
- Git installed and configured
- Basic command-line tools (mkdir, cat, cp)

## Installation Steps

### 1. Create ASDM directory structure

Create the required directory structure for all ASDM toolsets:

```bash
mkdir -p .asdm/contexts
mkdir -p .asdm/prototypes
mkdir -p .asdm/workspace/features
mkdir -p .asdm/toolsets
```

### 2. Copy toolset files to workspace

If the toolsets are not already in the workspace, copy them from the ASDM core assets:

```bash
# Copy each toolset to the .asdm/toolsets directory
cp -r /path/to/asdm-core-assets/toolsets/basic-tools .asdm/toolsets/
cp -r /path/to/asdm-core-assets/toolsets/context-builder .asdm/toolsets/
cp -r /path/to/asdm-core-assets/toolsets/prd-builder .asdm/toolsets/
cp -r /path/to/asdm-core-assets/toolsets/prototype-builder .asdm/toolsets/
```

Or create symlinks if you prefer:

```bash
ln -s /path/to/asdm-core-assets/toolsets/basic-tools .asdm/toolsets/basic-tools
ln -s /path/to/asdm-core-assets/toolsets/context-builder .asdm/toolsets/context-builder
ln -s /path/to/asdm-core-assets/toolsets/prd-builder .asdm/toolsets/prd-builder
ln -s /path/to/asdm-core-assets/toolsets/prototype-builder .asdm/toolsets/prototype-builder
```

### 3. Detect the current Agentic Engine provider

Detect the current AI coding assistant provider using the following guidelines:

- If `.claude` directory exists, use **Claude Code**
- If `.github` directory exists, use **GitHub Copilot**
- If `.codebuddy` directory exists, use **Tencent CodeBuddy**
- If no such folder is found in the current workspace, prompt the user to select a provider manually

### 4. Create shortcut commands in the provider's entry point

Create shortcut commands for all ASDM toolsets based on the detected provider.

#### For Claude Code (`.claude/commands/`)

Claude Code uses Markdown files with Frontmatter metadata for slash commands. Create commands by concatenating Claude-specific frontmatter with instruction content:

```bash
mkdir -p .claude/commands/

# --- Basic Tools ---
# Start Project command
cat > .claude/commands/asdm-start-project.md << 'EOF'
---
description: "Detect workspace context and start the project in development mode"
argument-hint: "[optional: specific environment]"
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-start-project.md >> .claude/commands/asdm-start-project.md

# Git Commit Message command
cat > .claude/commands/asdm-git-commit-message.md << 'EOF'
---
description: "Generate a standard git commit message based on current changes"
argument-hint: "[optional: custom scope or context]"
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-git-commit-message.md >> .claude/commands/asdm-git-commit-message.md

# Git Commit command
cat > .claude/commands/asdm-git-commit.md << 'EOF'
---
description: "Commit changes to the current branch with generated commit message"
argument-hint: "[optional: specific files to commit]"
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-git-commit.md >> .claude/commands/asdm-git-commit.md

# --- Context Builder ---
# Context Build command
cat > .claude/commands/asdm-context-build.md << 'EOF'
---
description: "Generate initial context for the workspace"
argument-hint: "[additional prompt]"
---

EOF
cat .asdm/toolsets/context-builder/actions/asdm-context-build.md >> .claude/commands/asdm-context-build.md

# Context Update command
cat > .claude/commands/asdm-context-update.md << 'EOF'
---
description: "Update existing context when workspace changes"
argument-hint: "[additional prompt]"
---

EOF
cat .asdm/toolsets/context-builder/actions/asdm-context-update.md >> .claude/commands/asdm-context-update.md

# --- PRD Builder ---
# PRD Planning command
cat > .claude/commands/asdm-prd-planning.md << 'EOF'
---
description: "Plan tasks for a workspace feature"
argument-hint: "[feature description]"
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-planning.md >> .claude/commands/asdm-prd-planning.md

# PRD Breakdown command
cat > .claude/commands/asdm-prd-breakdown.md << 'EOF'
---
description: "Break down tasks for a workspace feature"
argument-hint: "[feature ID or name]"
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-breakdown.md >> .claude/commands/asdm-prd-breakdown.md

# PRD Execution command
cat > .claude/commands/asdm-prd-execution.md << 'EOF'
---
description: "Execute tasks for a workspace feature"
argument-hint: "[task ID]"
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-execution.md >> .claude/commands/asdm-prd-execution.md

# --- Prototype Builder ---
# Prototype Create command
cat > .claude/commands/asdm-prototype-create.md << 'EOF'
---
description: "Generate a complete prototype from requirements"
argument-hint: "[requirements description]"
---

EOF
cat .asdm/toolsets/prototype-builder/actions/asdm-prototype-create.md >> .claude/commands/asdm-prototype-create.md

# Prototype Scaffold command
cat > .claude/commands/asdm-prototype-scaffold.md << 'EOF'
---
description: "Scaffold a new project with specific tech stack"
argument-hint: "[project name]"
---

EOF
cat .asdm/toolsets/prototype-builder/actions/asdm-prototype-scaffold.md >> .claude/commands/asdm-prototype-scaffold.md
```

#### For GitHub Copilot (`.github/prompts/`)

GitHub Copilot uses `.prompt.md` files with YAML frontmatter. Create prompt files by concatenating GitHub-specific frontmatter with instruction content:

```bash
mkdir -p .github/prompts/

# --- Basic Tools ---
cat > .github/prompts/asdm-start-project.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Detect workspace context and start the project in development mode'
argument-hint: 'Enter optional environment or leave blank'
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-start-project.md >> .github/prompts/asdm-start-project.prompt.md

cat > .github/prompts/asdm-git-commit-message.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Generate a standard git commit message based on current changes'
argument-hint: 'Enter optional scope or context'
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-git-commit-message.md >> .github/prompts/asdm-git-commit-message.prompt.md

cat > .github/prompts/asdm-git-commit.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Commit changes to the current branch with generated commit message'
argument-hint: 'Enter optional specific files to commit'
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-git-commit.md >> .github/prompts/asdm-git-commit.prompt.md

# --- Context Builder ---
cat > .github/prompts/asdm-context-build.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Generate initial context for the workspace'
argument-hint: 'Enter additional prompt'
---

EOF
cat .asdm/toolsets/context-builder/actions/asdm-context-build.md >> .github/prompts/asdm-context-build.prompt.md

cat > .github/prompts/asdm-context-update.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Update existing context when workspace changes'
argument-hint: 'Enter additional prompt'
---

EOF
cat .asdm/toolsets/context-builder/actions/asdm-context-update.md >> .github/prompts/asdm-context-update.prompt.md

# --- PRD Builder ---
cat > .github/prompts/asdm-prd-planning.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Plan tasks for a workspace feature'
argument-hint: 'Enter feature description'
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-planning.md >> .github/prompts/asdm-prd-planning.prompt.md

cat > .github/prompts/asdm-prd-breakdown.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Break down tasks for a workspace feature'
argument-hint: 'Enter feature ID or name'
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-breakdown.md >> .github/prompts/asdm-prd-breakdown.prompt.md

cat > .github/prompts/asdm-prd-execution.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Execute tasks for a workspace feature'
argument-hint: 'Enter task ID'
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-execution.md >> .github/prompts/asdm-prd-execution.prompt.md

# --- Prototype Builder ---
cat > .github/prompts/asdm-prototype-create.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Generate a complete prototype from requirements'
argument-hint: 'Enter requirements description'
---

EOF
cat .asdm/toolsets/prototype-builder/actions/asdm-prototype-create.md >> .github/prompts/asdm-prototype-create.prompt.md

cat > .github/prompts/asdm-prototype-scaffold.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Scaffold a new project with specific tech stack'
argument-hint: 'Enter project name'
---

EOF
cat .asdm/toolsets/prototype-builder/actions/asdm-prototype-scaffold.md >> .github/prompts/asdm-prototype-scaffold.prompt.md
```

#### For Tencent CodeBuddy (`.codebuddy/commands/`)

CodeBuddy doesn't support frontmatter, so simply copy the instruction files as-is:

```bash
mkdir -p .codebuddy/commands/

# --- Basic Tools ---
cp .asdm/toolsets/basic-tools/actions/asdm-start-project.md .codebuddy/commands/
cp .asdm/toolsets/basic-tools/actions/asdm-git-commit-message.md .codebuddy/commands/
cp .asdm/toolsets/basic-tools/actions/asdm-git-commit.md .codebuddy/commands/

# --- Context Builder ---
cp .asdm/toolsets/context-builder/actions/asdm-context-build.md .codebuddy/commands/
cp .asdm/toolsets/context-builder/actions/asdm-context-update.md .codebuddy/commands/

# --- PRD Builder ---
cp .asdm/toolsets/prd-builder/actions/asdm-prd-planning.md .codebuddy/commands/
cp .asdm/toolsets/prd-builder/actions/asdm-prd-breakdown.md .codebuddy/commands/
cp .asdm/toolsets/prd-builder/actions/asdm-prd-execution.md .codebuddy/commands/

# --- Prototype Builder ---
cp .asdm/toolsets/prototype-builder/actions/asdm-prototype-create.md .codebuddy/commands/
cp .asdm/toolsets/prototype-builder/actions/asdm-prototype-scaffold.md .codebuddy/commands/
```

### 5. Manual Usage for Other Providers

If your AI coding assistant provider is not detected, you can directly use the instruction files by copying their relative paths and pasting them into your AI coding assistant's chat window:

```
Follow the instructions in {relative path to instruction file}
```

Available instruction files:

| Toolset | Action | Instruction File |
|---------|--------|-----------------|
| Basic Tools | Start Project | `.asdm/toolsets/basic-tools/actions/asdm-start-project.md` |
| Basic Tools | Git Commit Message | `.asdm/toolsets/basic-tools/actions/asdm-git-commit-message.md` |
| Basic Tools | Git Commit | `.asdm/toolsets/basic-tools/actions/asdm-git-commit.md` |
| Context Builder | Context Build | `.asdm/toolsets/context-builder/actions/asdm-context-build.md` |
| Context Builder | Context Update | `.asdm/toolsets/context-builder/actions/asdm-context-update.md` |
| PRD Builder | PRD Planning | `.asdm/toolsets/prd-builder/actions/asdm-prd-planning.md` |
| PRD Builder | PRD Breakdown | `.asdm/toolsets/prd-builder/actions/asdm-prd-breakdown.md` |
| PRD Builder | PRD Execution | `.asdm/toolsets/prd-builder/actions/asdm-prd-execution.md` |
| Prototype Builder | Prototype Create | `.asdm/toolsets/prototype-builder/actions/asdm-prototype-create.md` |
| Prototype Builder | Prototype Scaffold | `.asdm/toolsets/prototype-builder/actions/asdm-prototype-scaffold.md` |

## Available Commands

Once installed, all ASDM commands are available:

### Basic Tools

| Command | Description |
|---------|-------------|
| `/asdm-start-project` | Detect workspace context and start the project in development mode |
| `/asdm-git-commit-message` | Generate a standard git commit message based on current changes |
| `/asdm-git-commit` | Commit changes to the current branch with generated commit message |

### Context Builder

| Command | Description |
|---------|-------------|
| `/asdm-context-build` | Generate initial context for the workspace |
| `/asdm-context-update` | Update existing context when workspace changes |

### PRD Builder

| Command | Description |
|---------|-------------|
| `/asdm-prd-planning` | Plan tasks for a workspace feature |
| `/asdm-prd-breakdown` | Break down tasks for a workspace feature |
| `/asdm-prd-execution` | Execute tasks for a workspace feature |

### Prototype Builder

| Command | Description |
|---------|-------------|
| `/asdm-prototype-create` | Generate a complete prototype from requirements |
| `/asdm-prototype-scaffold` | Scaffold a new project with specific tech stack |

## Recommended Workflow

The ASDM toolsets work together in a recommended workflow:

1. **Build Context** (`/asdm-context-build`) - Generate initial workspace context so the AI model understands your codebase
2. **Plan Feature** (`/asdm-prd-planning`) - Create a feature PRD and task plan
3. **Break Down Tasks** (`/asdm-prd-breakdown`) - Generate detailed task PRD documents
4. **Execute Tasks** (`/asdm-prd-execution`) - Implement the tasks one by one
5. **Commit Changes** (`/asdm-git-commit-message` + `/asdm-git-commit`) - Generate and commit changes with standard messages

If you need a rapid prototype before full development, use:

1. **Scaffold** (`/asdm-prototype-scaffold`) - Create a project skeleton
2. **Create Prototype** (`/asdm-prototype-create`) - Generate a complete prototype from requirements

## Workspace Directory Structure

After installation, the ASDM workspace will have the following structure:

```
.asdm/
├── contexts/                    # Context files (generated by Context Builder)
│   ├── index.md                 # Workspace index
│   ├── architecture.md          # System architecture
│   ├── data-models.md           # Data models
│   ├── api.md                   # API definitions
│   ├── deployment.md            # Deployment config
│   ├── standard-project-structure.md
│   └── standard-coding-style.md
├── prototypes/                  # Generated prototypes (by Prototype Builder)
├── workspace/
│   └── features/                # Feature and task files (by PRD Builder)
│       ├── features-list.md     # Feature tracking list
│       └── <feature-id>/        # Feature workspace
│           ├── feature-prd.md
│           ├── task-list.md
│           └── <task-id>-prd.md
└── toolsets/                    # ASDM toolset definitions
    ├── basic-tools/
    ├── context-builder/
    ├── prd-builder/
    └── prototype-builder/
```

## Verification

After installation, verify that:

1. The `.asdm/contexts`, `.asdm/prototypes`, `.asdm/workspace/features` directories exist
2. All four toolset directories are present under `.asdm/toolsets/`
3. Shortcut commands are created in the appropriate provider directory (`.claude/commands/`, `.github/prompts/`, or `.codebuddy/commands/`)
4. You can run any of the available slash commands

## Uninstallation

To remove the ASDM workspace:

```bash
# Remove ASDM directories
rm -rf .asdm/contexts
rm -rf .asdm/prototypes
rm -rf .asdm/workspace/features

# Remove toolset shortcut commands (choose based on your provider)
rm -f .claude/commands/asdm-*.md          # Claude Code
rm -f .github/prompts/asdm-*.prompt.md    # GitHub Copilot
rm -f .codebuddy/commands/asdm-*.md       # Tencent CodeBuddy

# Optionally remove toolset definitions
rm -rf .asdm/toolsets
```

## Getting Help

For issues with ASDM toolsets, refer to:

- [ASDM Documentation](https://asdm.ai/docs)
- Individual toolset README files in `.asdm/toolsets/*/README.md`
- Individual toolset INSTALL files in `.asdm/toolsets/*/INSTALL.md`

## License

Copyright (c) 2026 LeansoftX.com & iSoftStone. All rights reserved.

Licensed under the PROPRIETARY SOFTWARE LICENSE. See [LICENSE](LICENSE) in the project root for license information.

---

*This installation document is part of the ASDM workspace. Follow the recommended workflow to leverage all toolsets effectively.*