diff --git a/.agent/workflows/technical-writer-review.md b/.agent/workflows/technical-writer-review.md new file mode 100644 index 00000000..aefe2e66 --- /dev/null +++ b/.agent/workflows/technical-writer-review.md @@ -0,0 +1,81 @@ +--- +description: Review and improve documentation for novice users with technical writing best practices +--- + +# Technical Writer Review Workflow + +Review documentation files from a professional technical writer's perspective, focusing on novice user experience. + +## Review Criteria + +For each document, evaluate: + +### 1. Clarity (Is it easy to understand?) +- Does it explain concepts before using them? +- Does it avoid jargon, or explain it when necessary? +- Are examples concrete and realistic? + +### 2. Completeness (Does it cover what users need?) +- Does it explain *what* something is before *how* to use it? +- Are prerequisites clearly stated? +- Are there quick start examples? +- Are edge cases and errors addressed? + +### 3. Actionability (Can users follow along?) +- Are commands copy-paste ready? +- Is expected output shown? +- Are "when to use" hints provided? +- Do links to related docs exist? + +### 4. Structure (Is it well organized?) +- Does the order make sense for newcomers? +- Are sections clearly separated? +- Is there a logical flow from simple to complex? + +## Review Output Format + +For each document, provide: + +```markdown +## [Document Name] + +| Aspect | Rating (1-5) | Notes | +|--------|--------------|-------| +| Clarity | ⭐⭐⭐ | ... | +| Completeness | ⭐⭐ | ... | +| Actionability | ⭐⭐⭐⭐ | ... | +| Structure | ⭐⭐⭐ | ... | + +**Issues:** +1. Issue description +2. Issue description + +**Suggested Fixes:** +- Fix description +``` + +## Common Patterns to Fix + +| Issue | Fix | +|-------|-----| +| Missing intro | Add opening paragraph explaining what and why | +| No prerequisites | Add prerequisites section with requirements | +| Jargon without explanation | Add callout boxes explaining terminology | +| No examples | Add Quick Start or example sections | +| Flat structure | Organize into logical sections | +| No cross-references | Add "Next Steps" or "See Also" links | +| Terminal vs editor confusion | Clarify which commands run where | + +## Workflow Steps + +1. **Read the document** from start to finish as a novice would +2. **Rate each aspect** using the criteria above +3. **Identify specific issues** with line references +4. **Suggest concrete fixes** with example text +5. **Prioritize fixes** as High/Medium/Low impact + +## Priority Levels + +- **High**: Blocks novice users from succeeding +- **Medium**: Causes confusion but users can figure it out +- **Low**: Nice to have improvements diff --git a/CHANGELOG.md b/CHANGELOG.md index 57ffc253..06b476f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,14 +5,28 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [0.7.1] - 2026-01-26 + +### Added +- **Memory Skill Template** - New skill for integrating memory service capabilities into agent workflows +- **Comprehensive Documentation** - Added extensive documentation pages for: + - Getting Started guide + - Supported AI agents reference + - Development with AI DevKit + - Debug workflows + - Understanding existing code + - Memory service usage + - Skills management +- Updated base template for all environments + +## [0.7.0] - 2026-01-25 ### Added - **Skill Management** - Centralized registry for managing Agent Skills across projects - - 🎯 **One-Command Installation**: `ai-devkit skill add / ` - - 💾 **Local Cache**: Skills stored in `~/.ai-devkit/skills/` to avoid duplication - - 🔗 **Symlink-First Strategy**: Symlinks with automatic copy fallback for Windows - - 🎨 **Multi-Environment Support**: Works with Cursor, Claude Code, Codex, OpenCode, and Antigravity + - **One-Command Installation**: `ai-devkit skill add / ` + - **Local Cache**: Skills stored in `~/.ai-devkit/skills/` to avoid duplication + - **Symlink-First Strategy**: Symlinks with automatic copy fallback for Windows + - **Multi-Environment Support**: Works with Cursor, Claude Code, Codex, OpenCode, and Antigravity - **CLI Commands**: - `ai-devkit skill add / ` - Install a skill from registry - `ai-devkit skill list` - List all installed skills with sources @@ -23,7 +37,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Environment filtering (only shows/uses environments with skill support) - Git repository caching for efficient reuse across projects - Validation for registry IDs and skill names (follows Agent Skills spec) - - **Test Coverage**: 67 new unit tests (187 total tests passing) ## [0.6.0] - 2026-01-22 diff --git a/package-lock.json b/package-lock.json index 7bf074a2..721d3632 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12976,7 +12976,7 @@ }, "packages/cli": { "name": "ai-devkit", - "version": "0.7.0", + "version": "0.8.0", "license": "MIT", "dependencies": { "@ai-devkit/memory": "^0.2.0", diff --git a/packages/cli/README.md b/packages/cli/README.md index c2010ded..a6423116 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -1,6 +1,3 @@ -# @ai-devkit/cli -> Part of [AI DevKit](https://github.com/Codeaholicguy/ai-devkit) - The official command-line interface for **AI DevKit**. This tool orchestrates the setup and management of AI-assisted development environments, ensuring your project is ready for agents like Cursor, Claude Code, and more. diff --git a/packages/cli/package.json b/packages/cli/package.json index c8e6c4bf..62010e27 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "ai-devkit", - "version": "0.7.0", + "version": "0.8.0", "description": "A CLI toolkit for AI-assisted software development with phase templates and environment setup", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/packages/cli/src/lib/SkillManager.ts b/packages/cli/src/lib/SkillManager.ts index 419b30c0..8690a6f1 100644 --- a/packages/cli/src/lib/SkillManager.ts +++ b/packages/cli/src/lib/SkillManager.ts @@ -161,6 +161,7 @@ export class SkillManager { registry = `${parts[0]}/${parts[1]}`; } } catch { + // Ignore errors } skills.push({ diff --git a/packages/cli/templates/env/base.md b/packages/cli/templates/env/base.md index a2fbc8a0..bf60e87a 100644 --- a/packages/cli/templates/env/base.md +++ b/packages/cli/templates/env/base.md @@ -28,8 +28,26 @@ This project uses ai-devkit for structured AI-assisted development. Phase docume - For new features, start with requirements clarification - Update phase docs when significant changes or decisions are made +## Skills (Extend Your Capabilities) +Skills are packaged capabilities that teach you new competencies, patterns, and best practices. Check for installed skills in the project's skill directory and use them to enhance your work. + +### Using Installed Skills +1. **Check for skills**: Look for `SKILL.md` files in the project's skill directory +2. **Read skill instructions**: Each skill contains detailed guidance on when and how to use it +3. **Apply skill knowledge**: Follow the patterns, commands, and best practices defined in the skill + +### Key Installed Skills +- **memory**: Use AI DevKit's memory service via CLI commands when MCP is unavailable. Read the skill for detailed `memory store` and `memory search` command usage. + +### When to Reference Skills +- Before implementing features that match a skill's domain +- When MCP tools are unavailable but skill provides CLI alternatives +- To follow established patterns and conventions defined in skills + ## Knowledge Memory (Always Use When Helpful) -The AI assistant should proactively use knowledge memory throughout all interactions: +The AI assistant should proactively use knowledge memory throughout all interactions. + +> **Tip**: If MCP is unavailable, use the **memory skill** for detailed CLI command reference. ### When to Search Memory - Before starting any task, search for relevant project conventions, patterns, or decisions @@ -39,7 +57,7 @@ The AI assistant should proactively use knowledge memory throughout all interact **How to search**: - Use `memory.searchKnowledge` MCP tool with relevant keywords, tags, and scope -- If MCP tools are unavailable, use `npx ai-devkit memory search` CLI command +- If MCP tools are unavailable, use `npx ai-devkit memory search` CLI command (see memory skill for details) - Example: Search for "authentication patterns" when implementing auth features ### When to Store Memory @@ -49,8 +67,8 @@ The AI assistant should proactively use knowledge memory throughout all interact - When you establish new conventions or standards for the project **How to store**: -- Use `memory.storeKnowledge` MCP tool or run `/remember` command -- If MCP tools are unavailable, use `npx ai-devkit memory store` CLI command +- Use `memory.storeKnowledge` MCP tool +- If MCP tools are unavailable, use `npx ai-devkit memory store` CLI command (see memory skill for details) - Include clear title, detailed content, relevant tags, and appropriate scope - Make knowledge specific and actionable, not generic advice @@ -79,5 +97,5 @@ When working on this project, you can run commands to: - Review architectural decisions (`review-design`) - Plan and execute tasks (`execute-plan`) - Verify implementation against design (`check-implementation`) -- Suggest missing tests (`suggest-tests`) -- Perform structured code reviews (`code-review`) \ No newline at end of file +- Writing tests (`writing-test`) +- Perform structured code reviews (`code-review`) diff --git a/skills/memory/SKILL.md b/skills/memory/SKILL.md new file mode 100644 index 00000000..8af194c4 --- /dev/null +++ b/skills/memory/SKILL.md @@ -0,0 +1,200 @@ +--- +name: memory +description: Use AI DevKit's memory service to store and retrieve knowledge via CLI commands instead of MCP. +--- + +# AI DevKit Memory Skill + +This skill teaches you how to use AI DevKit's **Memory** service through CLI commands. Memory allows you to store actionable insights, coding patterns, and project guidelines that persist across sessions. + +## When to Use This Skill + +Use the memory CLI commands when: +- MCP (Model Context Protocol) is not available or not configured +- You need to store knowledge directly from the terminal +- You want to search for previously stored patterns or guidelines +- You're scripting memory operations + +## Prerequisites + +Ensure AI DevKit CLI is available: +```bash +npx ai-devkit --version +``` + +## Commands Reference + +### Storing Knowledge + +Store new knowledge items using the `memory store` command: + +```bash +npx ai-devkit memory store \ + --title "" \ + --content "" \ + --tags "" \ + --scope "" +``` + +**Parameters:** + +| Parameter | Required | Description | +|-------------|----------|-------------| +| `--title` | Yes | Short, descriptive title (5-12 words, 10-100 chars) | +| `--content` | Yes | Detailed explanation in markdown format (50-5000 chars) | +| `--tags` | No | Comma-separated domain keywords (e.g., `typescript,react`) | +| `--scope` | No | `global` (default), `project:`, or `repo:` | + +**Examples:** + +```bash +# Store a global coding pattern +npx ai-devkit memory store \ + --title "Always handle BigInt serialization in API responses" \ + --content "When returning BigInt values from API endpoints, convert them to strings using \`BigInt.toString()\` before serialization. JSON.stringify() cannot serialize BigInt natively." \ + --tags "api,backend,serialization" \ + --scope "global" + +# Store project-specific knowledge +npx ai-devkit memory store \ + --title "Use pnpm for package management" \ + --content "This monorepo uses pnpm workspaces. Always use 'pnpm' instead of 'npm' or 'yarn'. Install dependencies with 'pnpm install' and run scripts with 'pnpm run