Compare commits
1 Commits
issue-43-v
...
issue-44-r
| Author | SHA1 | Date | |
|---|---|---|---|
|
f1c555706b
|
112
CLAUDE.md
112
CLAUDE.md
@@ -1,20 +1,34 @@
|
|||||||
# Claude Code AI Workflow
|
# Architecture
|
||||||
|
|
||||||
This repository contains configurations, prompts, and tools to improve the Claude Code AI workflow.
|
This repository is the organizational source of truth: how we work, who we serve, what we believe, and how we build software with AI.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone and install symlinks
|
# Clone and install symlinks
|
||||||
git clone ssh://git@code.flowmade.one/flowmade-one/ai.git
|
git clone ssh://git@code.flowmade.one/flowmade-one/architecture.git
|
||||||
cd ai
|
cd architecture
|
||||||
make install
|
make install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## What This Repo Contains
|
||||||
|
|
||||||
|
| Component | Purpose |
|
||||||
|
|-----------|---------|
|
||||||
|
| `manifesto.md` | Organization vision, personas, beliefs, principles |
|
||||||
|
| `learnings/` | Historical record and governance |
|
||||||
|
| `commands/` | AI workflow entry points (/work-issue, /manifesto, etc.) |
|
||||||
|
| `skills/` | Tool and practice knowledge |
|
||||||
|
| `agents/` | Focused subtask handlers |
|
||||||
|
| `settings.json` | Claude Code configuration |
|
||||||
|
| `Makefile` | Install symlinks to ~/.claude/ |
|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
ai/
|
architecture/
|
||||||
|
├── manifesto.md # Organization vision and beliefs
|
||||||
|
├── learnings/ # Captured learnings and governance
|
||||||
├── commands/ # Slash commands (/work-issue, /dashboard)
|
├── commands/ # Slash commands (/work-issue, /dashboard)
|
||||||
├── skills/ # Knowledge modules (auto-triggered)
|
├── skills/ # Knowledge modules (auto-triggered)
|
||||||
├── agents/ # Focused subtask handlers (isolated context)
|
├── agents/ # Focused subtask handlers (isolated context)
|
||||||
@@ -25,41 +39,28 @@ ai/
|
|||||||
|
|
||||||
All files symlink to `~/.claude/` via `make install`.
|
All files symlink to `~/.claude/` via `make install`.
|
||||||
|
|
||||||
## Architecture
|
## Two Levels of Vision
|
||||||
|
|
||||||
### Skills
|
| Level | Document | Command | Purpose |
|
||||||
Knowledge modules that teach Claude how to do something. Referenced by commands via `@~/.claude/skills/xxx/SKILL.md`.
|
|-------|----------|---------|---------|
|
||||||
|
| Organization | `manifesto.md` | `/manifesto` | Who we are, shared personas, beliefs |
|
||||||
|
| Product | `vision.md` | `/vision` | Product-specific direction and goals |
|
||||||
|
|
||||||
- **Purpose**: Encode best practices and tool knowledge
|
See the manifesto for our identity, personas, and beliefs about AI-augmented development.
|
||||||
- **Location**: `skills/<name>/SKILL.md`
|
|
||||||
- **Usage**: Included in commands for context, auto-triggered by Claude Code
|
|
||||||
|
|
||||||
Example: `gitea` skill teaches tea CLI usage, `issue-writing` teaches how to structure issues.
|
## Available Commands
|
||||||
|
|
||||||
### Commands
|
| Command | Description |
|
||||||
User-facing entry points invoked with `/command-name`. Run in main conversation context.
|
|---------|-------------|
|
||||||
|
| `/manifesto` | View/manage organization manifesto |
|
||||||
- **Purpose**: Orchestrate workflows with user interaction
|
| `/vision` | View/manage product vision and milestones |
|
||||||
- **Location**: `commands/<name>.md`
|
| `/work-issue <n>` | Fetch issue, create branch, implement, create PR |
|
||||||
- **Usage**: User types `/dashboard`, `/work-issue 42`, etc.
|
| `/dashboard` | Show open issues and PRs |
|
||||||
|
| `/review-pr <n>` | Review PR with diff and comments |
|
||||||
Commands reference skills for knowledge and optionally spawn agents for subtasks.
|
| `/create-issue` | Create single or batch issues |
|
||||||
|
| `/retro` | Capture learnings as issues for encoding |
|
||||||
### Agents
|
| `/plan-issues` | Break down features into issues |
|
||||||
Small, focused units that handle specific subtasks in isolated context.
|
| `/groom` | Improve issue quality |
|
||||||
|
|
||||||
- **Purpose**: Complex subtasks that benefit from isolation
|
|
||||||
- **Location**: `agents/<name>/agent.md`
|
|
||||||
- **Usage**: Spawned via Task tool, return results to caller
|
|
||||||
|
|
||||||
Good agent candidates:
|
|
||||||
- Code review (analyze diff, report issues)
|
|
||||||
- Content generation (write issue body, PR description)
|
|
||||||
- Analysis tasks (categorize, prioritize, summarize)
|
|
||||||
|
|
||||||
**When to use agents vs direct execution:**
|
|
||||||
- Use agents when: task is self-contained, benefits from isolation, can run in parallel
|
|
||||||
- Use direct execution when: task needs conversation history, requires user interaction mid-task
|
|
||||||
|
|
||||||
## Gitea Integration
|
## Gitea Integration
|
||||||
|
|
||||||
@@ -73,19 +74,32 @@ tea logins add --name flowmade --url https://git.flowmade.one --token <your-toke
|
|||||||
# Create token at: https://git.flowmade.one/user/settings/applications
|
# Create token at: https://git.flowmade.one/user/settings/applications
|
||||||
```
|
```
|
||||||
|
|
||||||
## Available Commands
|
## Architecture Components
|
||||||
|
|
||||||
| Command | Description |
|
### Skills
|
||||||
|---------|-------------|
|
Knowledge modules that teach Claude how to do something.
|
||||||
| `/work-issue <n>` | Fetch issue, create branch, implement, create PR |
|
|
||||||
| `/dashboard` | Show open issues and PRs |
|
|
||||||
| `/review-pr <n>` | Review PR with diff and comments |
|
|
||||||
| `/create-issue` | Create single or batch issues |
|
|
||||||
| `/retro` | Capture learnings, create improvement issues |
|
|
||||||
| `/vision` | View/manage product vision and milestones |
|
|
||||||
| `/plan-issues` | Break down features into issues |
|
|
||||||
| `/improve` | Identify gaps between vision and backlog |
|
|
||||||
|
|
||||||
## Vision & Goals
|
- **Purpose**: Encode best practices and tool knowledge
|
||||||
|
- **Location**: `skills/<name>/SKILL.md`
|
||||||
|
- **Usage**: Referenced by commands via `@~/.claude/skills/xxx/SKILL.md`
|
||||||
|
|
||||||
Product vision lives in `vision.md` (philosophy) and Gitea milestones (goals with progress tracking). See `/vision` command.
|
### Commands
|
||||||
|
User-facing entry points invoked with `/command-name`.
|
||||||
|
|
||||||
|
- **Purpose**: Orchestrate workflows with user interaction
|
||||||
|
- **Location**: `commands/<name>.md`
|
||||||
|
- **Usage**: User types `/dashboard`, `/work-issue 42`, etc.
|
||||||
|
|
||||||
|
### Agents
|
||||||
|
Focused units that handle specific subtasks in isolated context.
|
||||||
|
|
||||||
|
- **Purpose**: Complex subtasks that benefit from isolation
|
||||||
|
- **Location**: `agents/<name>/agent.md`
|
||||||
|
- **Usage**: Spawned via Task tool, return results to caller
|
||||||
|
|
||||||
|
### Learnings
|
||||||
|
Captured insights from work, encoded into skills/commands/agents.
|
||||||
|
|
||||||
|
- **Purpose**: Historical record + governance + continuous improvement
|
||||||
|
- **Location**: `learnings/YYYY-MM-DD-title.md`
|
||||||
|
- **Flow**: Retro → Issue → Encode into learning + system update
|
||||||
|
|||||||
12
README.md
12
README.md
@@ -1,4 +1,6 @@
|
|||||||
# Claude Code AI Workflow
|
# Architecture
|
||||||
|
|
||||||
|
The organizational source of truth: how we work, who we serve, what we believe, and how we build software with AI.
|
||||||
|
|
||||||
A composable toolkit for enhancing [Claude Code](https://claude.ai/claude-code) with structured workflows, issue management, and AI-assisted development practices.
|
A composable toolkit for enhancing [Claude Code](https://claude.ai/claude-code) with structured workflows, issue management, and AI-assisted development practices.
|
||||||
|
|
||||||
@@ -53,8 +55,8 @@ The project is built around three composable component types:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone the repository
|
# Clone the repository
|
||||||
git clone ssh://git@code.flowmade.one/flowmade-one/ai.git
|
git clone ssh://git@code.flowmade.one/flowmade-one/architecture.git
|
||||||
cd ai
|
cd architecture
|
||||||
|
|
||||||
# Install symlinks to ~/.claude/
|
# Install symlinks to ~/.claude/
|
||||||
make install
|
make install
|
||||||
@@ -87,7 +89,9 @@ echo "YOUR_TOKEN" | tea -H code.flowmade.one auth add-key username
|
|||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
ai/
|
architecture/
|
||||||
|
├── manifesto.md # Organization vision, personas, beliefs
|
||||||
|
├── learnings/ # Captured learnings and governance
|
||||||
├── commands/ # Slash commands invoked by users
|
├── commands/ # Slash commands invoked by users
|
||||||
│ ├── work-issue.md
|
│ ├── work-issue.md
|
||||||
│ ├── dashboard.md
|
│ ├── dashboard.md
|
||||||
|
|||||||
@@ -32,10 +32,10 @@ The retro creates the issue. Encoding happens when the issue is worked on.
|
|||||||
- **Where to encode it**: Which skill, command, or agent should change?
|
- **Where to encode it**: Which skill, command, or agent should change?
|
||||||
- **Governance impact**: What does this mean for how we work?
|
- **Governance impact**: What does this mean for how we work?
|
||||||
|
|
||||||
4. **Create issue on architecture repo**: Always create issues on `flowmade-one/ai`:
|
4. **Create issue on architecture repo**: Always create issues on `flowmade-one/architecture`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
tea issues create -r flowmade-one/ai \
|
tea issues create -r flowmade-one/architecture \
|
||||||
--title "[Learning] <brief description>" \
|
--title "[Learning] <brief description>" \
|
||||||
--description "## Context
|
--description "## Context
|
||||||
[Task that triggered this insight]
|
[Task that triggered this insight]
|
||||||
|
|||||||
Reference in New Issue
Block a user