Skip to content
Merged
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
141 changes: 141 additions & 0 deletions .github/projects/active/agent-skills-standards-comprehensive/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
---
file_type: project-index
title: "Agent & Skills Standards Comprehensive Documentation"
description: "Comprehensive documentation standards for agents, skills, instructions, workflows, cookbooks, plugins, hooks, and prompts"
status: active
created_date: "2026-07-24"
last_updated: "2026-08-07"
version: "2.0"
---

# Agent & Skills Standards Comprehensive Documentation

**Status:** ✅ Phase 1-2 Complete | 🔜 Phase 3 Upcoming
**Owner:** LightSpeed Team
**Epic:** #1261
**Branch:** `docs/agent-skills-standards-comprehensive`
**Target:** `develop`

---

## 📋 Project Overview

Comprehensive documentation standards for creating agents, skills, instructions, workflows, cookbooks, plugins, hooks, and prompts in the LightSpeed `.github` repository.

**Deliverables:** 9 documentation standards files (3,800+ lines, 18+ diagrams, 25+ examples)

---

## 🎯 Key Artifacts

### Planning Documents

- [PLAN.md](./PLAN.md) — Original comprehensive plan
- [PLAN-EXPANDED.md](./PLAN-EXPANDED.md) — Enhanced plan with Phase 2-3 details
- [INDEX.md](./INDEX.md) — Project index and quick reference

### Completion Status

- [COMPLETION_STATUS.md](./COMPLETION_STATUS.md) — Detailed Phase 1-2 completion metrics

### Standards Documents (In Codebase)

All 9 standards are now in the `docs/` directory:

1. [docs/AGENT_STANDARDS.md](https://github.com/lightspeedwp/.github/blob/develop/docs/AGENT_STANDARDS.md) — Single-file & folder-based agent design
2. [docs/SKILLS_STANDARDS.md](https://github.com/lightspeedwp/.github/blob/develop/docs/SKILLS_STANDARDS.md) — Shared skills creation and reusability
3. [docs/INSTRUCTIONS_STANDARDS.md](https://github.com/lightspeedwp/.github/blob/develop/docs/INSTRUCTIONS_STANDARDS.md) — Instruction file creation standards
4. [docs/WORKFLOWS_STANDARDS.md](https://github.com/lightspeedwp/.github/blob/develop/docs/WORKFLOWS_STANDARDS.md) — Agentic workflows best practices
5. [docs/COOKBOOKS_STANDARDS.md](https://github.com/lightspeedwp/.github/blob/develop/docs/COOKBOOKS_STANDARDS.md) — Implementation guides and recipes
6. [docs/PROMPTS_STANDARDS.md](https://github.com/lightspeedwp/.github/blob/develop/docs/PROMPTS_STANDARDS.md) — Prompt engineering standards
7. [docs/PLUGINS_STANDARDS.md](https://github.com/lightspeedwp/.github/blob/develop/docs/PLUGINS_STANDARDS.md) — Plugin architecture and structure
8. [docs/HOOKS_STANDARDS.md](https://github.com/lightspeedwp/.github/blob/develop/docs/HOOKS_STANDARDS.md) — Event-driven hooks patterns
9. [docs/AI_REFERENCES_STANDARDS.md](https://github.com/lightspeedwp/.github/blob/develop/docs/AI_REFERENCES_STANDARDS.md) — AI model and runner references

---

## 📊 Phase Status

| Phase | Task | Status | Dates | Metrics |
|-------|------|--------|-------|---------|
| **Phase 1** | Documentation Creation | ✅ COMPLETE | 2026-07-24 | 9 files, 3,778 lines |
| **Phase 2** | Enhancement with Diagrams & Examples | ✅ COMPLETE | 2026-07-24 | 18+ diagrams, 25+ examples |
| **Phase 3** | Governance Integration & Release | 🔜 PENDING | 2026-08-07+ | AGENTS.md updates, release notes |

---

## 📈 Key Metrics

### Documentation Coverage

- **9 standards documents** created and merged
- **3,800+ lines** of comprehensive documentation
- **18+ Mermaid diagrams** for visual explanation
- **25+ real-world examples** from repository
- **100% frontmatter compliance** (schema validation)
- **0 linting errors** across all 9 files

### GitHub Issues

- **Epic #1261** — Closed ✅
- **Child Issues #1262–#1270** — All 9 closed ✅
- **Tracking Issues #1274, #1304** — Both closed ✅
- **Total:** 11 issues closed

### Pull Requests

- **PR #1251** (Phase 1) — Merged to develop ✅
- **PR #1312** (Phase 2) — Merged to develop ✅

---

## 🚀 What's Next (Phase 3)

### Governance Integration

- [ ] Update [AGENTS.md](https://github.com/lightspeedwp/.github/blob/develop/AGENTS.md) to reference all 9 standards
- [ ] Link standards from agent creation workflows
- [ ] Add to documentation site navigation

### Release Preparation

- [ ] Create comprehensive release notes
- [ ] Document standards availability
- [ ] Prepare migration guide for existing agents
- [ ] Announce availability to team

---

## 📚 Related Documentation

- [AGENT_CREATION.md](https://github.com/lightspeedwp/.github/blob/develop/docs/AGENT_CREATION.md) — Current agent spec
- [AGENTS.md](https://github.com/lightspeedwp/.github/blob/develop/AGENTS.md) — Global AI governance rules
- [BRANCHING_STRATEGY.md](https://github.com/lightspeedwp/.github/blob/develop/docs/BRANCHING_STRATEGY.md) — Branch naming and workflow

---

## 📖 How to Use This Project

### For Quick Reference

1. Read this README (5 min)
2. Check [COMPLETION_STATUS.md](./COMPLETION_STATUS.md) for metrics (5 min)
3. Browse the standards documents for your use case

### For Full Context

1. Read [PLAN.md](./PLAN.md) for original vision
2. Read [PLAN-EXPANDED.md](./PLAN-EXPANDED.md) for complete requirements
3. Review the 9 standards documents for comprehensive guidance

### For Governance Updates (Phase 3)

1. Use findings from Phase 1-2 completion status
2. Update AGENTS.md with cross-references
3. Create release notes and migration guide

---

**Project Status:** ✅ Active | Phases 1-2 Complete
**Last Updated:** 2026-08-07
**Maintained By:** LightSpeed Team
41 changes: 39 additions & 2 deletions .github/projects/active/agent-standards-initiative/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
---
file_type: project-index
title: "Agent & Plugin Standardization Initiative"
description: "Complete documentation package for multi-provider agent standardization (Claude, GitHub Copilot, OpenAI Codex)"
status: active
created_date: "2026-07-22"
last_updated: "2026-08-07"
version: "1.0"
---

# Agent & Plugin Standardization Initiative — Complete Documentation Package

**Created:** 2026-07-22
Expand Down Expand Up @@ -92,6 +102,7 @@ This package contains everything you need to standardize the LightSpeedWP agent
### By Role

**Executive Sponsor:**

```
IMPLEMENTATION_SUMMARY.md
├─ Overview
Expand All @@ -101,6 +112,7 @@ IMPLEMENTATION_SUMMARY.md
```

**Technical Lead:**

```
1. AGENT_STANDARDIZATION_AUDIT.md (complete)
2. PROMPT_1_PLAYWRIGHT_AGENT_REWRITE.md (PHASE 1)
Expand All @@ -109,6 +121,7 @@ IMPLEMENTATION_SUMMARY.md
```

**Individual Contributor (Agent Developer):**

```
1. IMPLEMENTATION_SUMMARY.md (sections 2-3: Framework, Roadmap)
2. AGENT_STANDARDIZATION_AUDIT.md (Part 2: Folder Structure)
Expand All @@ -117,6 +130,7 @@ IMPLEMENTATION_SUMMARY.md
```

**QA / Testing:**

```
1. IMPLEMENTATION_SUMMARY.md (section: Success Criteria)
2. AGENT_STANDARDIZATION_AUDIT.md (Part 2: Schemas & Hooks)
Expand All @@ -127,19 +141,22 @@ IMPLEMENTATION_SUMMARY.md
### By Workflow

**To Understand the Standards:**

```
1. AGENT_STANDARDIZATION_AUDIT.md (Part 2: Standardization Framework)
2. IMPLEMENTATION_SUMMARY.md (section: Standardization Framework)
```

**To Execute Phase 1:**

```
1. PROMPT_1_PLAYWRIGHT_AGENT_REWRITE.md (read all 7 phases first)
2. AGENT_STANDARDIZATION_AUDIT.md (reference folder structures)
3. Follow tasks systematically in PROMPT_1
```

**To Execute Phase 2 (Per Agent - 14 agents available):**

```
1. PHASE_2_BATCH_PROMPTS_INDEX.md (select your agent)
2. Use agent-specific batch prompt:
Expand All @@ -151,6 +168,7 @@ IMPLEMENTATION_SUMMARY.md
```

**To Understand Agent-Plugin Relationships:**

```
AGENT_STANDARDIZATION_AUDIT.md
└─ Part 2: Standardization Framework
Expand Down Expand Up @@ -183,23 +201,27 @@ AGENT_STANDARDIZATION_AUDIT.md
### The Three Layers of Structure

**Shared (Provider-Agnostic):**

- Core prompt (shared/core-prompt.md)
- Agent spec (AGENT.md)
- Common tools/skills

**Provider-Specific:**

- Agent instructions (claude/agent.md, copilot/agent.md, openai/agent.md)
- Tool definitions (claude/tools.json, copilot/skills.yaml, openai/tools.json)
- Response formats

**Plugin-Level:**

- Multiple agents grouped by domain
- Shared skills across agents
- Shared hooks for validation

### The Agents to Convert

**Current ChatGPT Exports (16 total):**

1. playwright-testing-agent ← **Phase 1 (PILOT)**
2. ai-readiness-estimator-agent
3. client-website-discovery-assistant-agent
Expand All @@ -222,6 +244,7 @@ AGENT_STANDARDIZATION_AUDIT.md
## 📊 Project Statistics

### Current State

- **Agents:** 41 total (25 `.agent.md` specs + 16 ChatGPT exports)
- **ChatGPT Exports:** 16 (not yet multi-provider compatible)
- **Plugins:** 6 existing
Expand All @@ -230,19 +253,22 @@ AGENT_STANDARDIZATION_AUDIT.md
- **Hooks:** 3

### After Phase 1 (Playwright)

- **New Schemas:** 4
- **New Hooks:** 4
- **New Instructions:** 4
- **New Plugin:** 1 (`lightspeed-playwright-testing`)

### After Phase 2 (Remaining Agents)

- **Converted Agents:** 16 total
- **Plugins:** 6-8 (grouped by domain)
- **Schemas:** 20 total
- **Hooks:** 7 total
- **Instructions:** 46 total

### After Phase 3 (Governance)

- **Unified AI Config:** ✅
- **Canonical Schema Registry:** ✅
- **Org-wide Hook Enforcement:** ✅
Expand All @@ -253,11 +279,13 @@ AGENT_STANDARDIZATION_AUDIT.md
## ⏱️ Timeline & Effort

### Phase 1: Playwright Testing Agent (Pilot)

- **Effort:** 12-18 hours
- **Duration:** 1-2 days of focused work
- **Benefit:** Define pattern for all future agents

**Breakdown:**

- Audit & Plan: 2-3h
- Restructure & Specs: 3-4h
- Provider Configs: 2-3h
Expand All @@ -266,19 +294,22 @@ AGENT_STANDARDIZATION_AUDIT.md
- Testing & Docs: 1-2h

### Phase 2: Remaining 15 Agents

- **Effort per Agent:** 2-4 hours
- **Total Effort:** 30-60 hours
- **Batching:** 2-3 agents per week
- **Duration:** 6-10 weeks
- **Benefit:** Complete multi-provider ecosystem

**Suggested Batching:**

- Week 1: Agents 1-3 (project-mgmt, planning, design)
- Week 2: Agents 4-6 (time-tracking, performance, estimation)
- Week 3: Agents 7-9 (prd, proposals, tour-operator)
- ... and so on

### Phase 3: Governance & Consolidation

- **Effort:** 4-8 hours
- **Duration:** 1-2 days
- **Benefit:** Unified, enforceable architecture
Expand All @@ -288,6 +319,7 @@ AGENT_STANDARDIZATION_AUDIT.md
## ✅ Success Criteria

### Phase 1 Success

- ✅ Playwright agent restructured
- ✅ Claude, Copilot, OpenAI configs created
- ✅ Plugin created & functional
Expand All @@ -298,6 +330,7 @@ AGENT_STANDARDIZATION_AUDIT.md
- ✅ All tests passing

### Full Project Success

- ✅ 16 agents converted
- ✅ 6-8 plugins created/organized
- ✅ Schemas & hooks enforcing standards
Expand Down Expand Up @@ -363,19 +396,23 @@ AGENT_STANDARDIZATION_AUDIT.md
## 📞 Support & Questions

### Documentation Questions

→ Review the appropriate audit or prompt document
→ Check `.github/instructions/` for additional guidance

### Implementation Questions

→ Refer to PROMPT_1 or PROMPT_2 step-by-step
→ Review playwright-testing-agent as reference

### Standards Questions

→ Check AGENT_STANDARDIZATION_AUDIT.md Part 2
→ Review IMPLEMENTATION_SUMMARY.md standardization section

### Technical Issues
→ Contact: contact@lightspeedwp.agency

→ Contact: <contact@lightspeedwp.agency>
→ Check: `.github/CLAUDE.md` for governance

---
Expand Down Expand Up @@ -409,7 +446,7 @@ AGENT_STANDARDIZATION_AUDIT.md
## 📋 Checklist: Before You Begin

- [ ] Read `IMPLEMENTATION_SUMMARY.md` completely
- [ ] Review `AGENT_STANDARDIZATION_AUDIT.md`
- [ ] Review `AGENT_STANDARDIZATION_AUDIT.md`
- [ ] Understand naming conventions
- [ ] Understand folder structure
- [ ] Get team approval on standards
Expand Down
Loading
Loading