Skip to content

Commit a8592e2

Browse files
CopilotRtur2003
andcommitted
Update all documentation: README, INDEX files, CHANGELOG, QUICK-START, CONTRIBUTING, CLAUDE.md
Co-authored-by: Rtur2003 <111705644+Rtur2003@users.noreply.github.com>
1 parent a9f5d25 commit a8592e2

10 files changed

Lines changed: 157 additions & 80 deletions

File tree

CHANGELOG.md

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,53 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
77
## [Unreleased]
88

99
### Added
10-
- **Accessibility Audit prompt** — ACCESS protocol for WCAG 2.2 compliance testing
11-
- **Migration & Upgrade prompt** — MIGRATE protocol for framework, database, and dependency migrations
12-
- **Monitoring & Observability prompt** — OBSERVE protocol for logs, metrics, traces, and alerting
13-
- **AI & LLM Integration prompt** — AUGMENT protocol for RAG, vector DBs, AI agents, and safety
14-
- **Game Development prompt** — Unity, Unreal, Godot, ECS, multiplayer patterns
15-
- **Embedded Systems & IoT prompt** — C, C++, Rust, FreeRTOS, MQTT, TinyML, safety-critical
16-
- **Full-Stack App example** — Next.js + tRPC + Prisma end-to-end walkthrough
17-
- **Security Audit example** — Node.js/Express vulnerability assessment walkthrough
18-
- **Refactoring example** — Legacy code improvement with before/after metrics
19-
- **Prompt Selector Guide** — Interactive decision tree for choosing the right prompt combination
20-
- **CLAUDE.md** — AI agent configuration for working on this repository
10+
- **API Design & GraphQL prompt** — SCHEMA protocol for schema-first design, DataLoader, caching, contract testing
11+
- **Cloud & Infrastructure prompt** — CLOUD protocol for IaC, multi-region, K8s, cost optimization
12+
- **Data Engineering prompt** — PIPELINE protocol for dbt, streaming, data quality, Apache Airflow
13+
- **Compliance & Governance prompt** — GOVERN protocol for GDPR, HIPAA, SOC 2, PCI DSS, STRIDE threat modeling
14+
- **Debugging & Troubleshooting prompt** — DEBUG protocol for production debugging, profiling, incident response
15+
- **Blockchain & Web3 project-type prompt** — Solidity, Rust, Foundry, smart contract security, gas optimization
16+
- **Desktop Application project-type prompt** — Tauri, Electron, Qt, native integration, auto-update
17+
- **Cloud Infrastructure example** — Terraform + K8s on AWS real-world deployment walkthrough
18+
- **AI Agent example** — Building an AI-powered code review agent with Claude API
19+
- **Troubleshooting Guide** — Systematic issue diagnosis decision flowchart with common patterns
20+
- Accessibility Audit prompt — ACCESS protocol for WCAG 2.2 compliance testing
21+
- Migration & Upgrade prompt — MIGRATE protocol for framework, database, and dependency migrations
22+
- Monitoring & Observability prompt — OBSERVE protocol for logs, metrics, traces, and alerting
23+
- AI & LLM Integration prompt — AUGMENT protocol for RAG, vector DBs, AI agents, and safety
24+
- Game Development prompt — Unity, Unreal, Godot, ECS, multiplayer patterns
25+
- Embedded Systems & IoT prompt — C, C++, Rust, FreeRTOS, MQTT, TinyML, safety-critical
26+
- Full-Stack App example — Next.js + tRPC + Prisma end-to-end walkthrough
27+
- Security Audit example — Node.js/Express vulnerability assessment walkthrough
28+
- Refactoring example — Legacy code improvement with before/after metrics
29+
- Prompt Selector Guide — Interactive decision tree for choosing the right prompt combination
30+
- CLAUDE.md — AI agent configuration for working on this repository
2131
- LICENSE file (MIT)
2232
- CHANGELOG.md for version tracking
23-
- Improved .gitignore with comprehensive patterns from Git & VCS prompt best practices
33+
34+
### Enhanced
35+
- **Security Audit prompt** — Added cloud security assessment, supply chain security, zero trust architecture
36+
- **Architecture Patterns prompt** — Added serverless architecture, event sourcing deep dive, saga pattern, data consistency patterns
37+
- **Testing Strategies prompt** — Added contract testing (Pact), property-based testing (Hypothesis, fast-check), chaos testing, anti-patterns table
38+
- **Performance Optimization prompt** — Added GraphQL N+1 prevention, memory profiling (Node.js + Python), CDN/edge optimization, Cloudflare Workers
39+
- **Full-Stack Development prompt** — Added WebSocket/SSE real-time patterns, Socket.io integration, BullMQ background jobs
40+
- **API Development prompt** — Added idempotency keys, cursor-based pagination, webhook delivery with retries
41+
- **Data Science & ML prompt** — Added MLOps section with model monitoring (drift detection), SHAP/LIME explainability, MLflow experiment tracking, model registry
42+
- **Web Development prompt** — Added SEO/meta tags (Open Graph, JSON-LD), font optimization (preload, swap), image optimization (WebP, lazy loading), accessibility quick wins
2443

2544
### Changed
26-
- Updated README.md with 4 new agent prompts, 2 new project types, expanded combinations table
45+
- Updated README.md with all new prompts, expanded combinations table (36 combinations), updated architecture section
2746
- Updated QUICK-START.md with all new prompts and resources
2847
- Updated USAGE.md with new scenarios for all new prompts
2948
- Updated CONTRIBUTING.md with new file counts and contribution types
30-
- Updated all INDEX.md files with new prompt entries and feature matrix
31-
- Made repository fully English-only and global (removed language-specific content)
32-
- Expanded feature matrix to include Game and IoT columns
33-
- Agent prompt count: 19 → 23
34-
- Project type prompt count: 7 → 9
35-
- Example count: 2 → 5
36-
- Total prompt files: 26 → 32
49+
- Updated all INDEX.md files with new prompt entries and expanded feature matrix
50+
- Made repository fully English-only and global
51+
- Expanded feature matrix to include Blockchain and Desktop columns
52+
- Agent prompt count: 23 → 28
53+
- Project type prompt count: 9 → 11
54+
- Example count: 5 → 7
55+
- Workflow guide count: 2 → 3
56+
- Total prompt files: 32 → 39
3757

3858
### Removed
3959
- Turkish translations directory (repository is now English-only for global accessibility)

CLAUDE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@
2020
└── prompts/
2121
└── english/
2222
├── INDEX.md # All prompts organized by category
23-
├── agents/ # Agent-optimized prompts (autonomous AI)
23+
├── agents/ # Agent-optimized prompts (28 files)
2424
│ └── INDEX.md
2525
├── base/ # Foundation prompt (universal best practices)
26-
├── project-types/ # Domain-specific prompts (web, API, ML, mobile, etc.)
27-
├── examples/ # Real-world usage examples
28-
└── workflows/ # APEI methodology guide
26+
├── project-types/ # Domain-specific prompts (11 files: web, API, ML, mobile, blockchain, desktop, etc.)
27+
├── examples/ # Real-world usage examples (7 files)
28+
└── workflows/ # APEI methodology, prompt selection & troubleshooting guides
2929
```
3030

3131
## File Naming Conventions

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
| Type | Description |
66
|------|-------------|
7-
| **New Project Types** | Game dev, blockchain, embedded systems, etc. |
8-
| **New Agent Types** | Architecture review, accessibility audit, etc. |
7+
| **New Project Types** | Desktop apps, data engineering, etc. |
8+
| **New Agent Types** | Specialized agent prompts with protocol acronyms |
99
| **New Examples** | Real-world walkthroughs demonstrating APEI cycle |
1010
| **Improvements** | Better practices, clearer instructions, examples |
1111
| **Bug Fixes** | Typos, broken links, formatting issues |
@@ -23,11 +23,11 @@ git checkout -b feature/your-feature-name
2323
```
2424
prompts/
2525
└── english/
26-
├── agents/ # Agent-optimized prompts (23 files)
26+
├── agents/ # Agent-optimized prompts (28 files)
2727
├── base/ # Foundation prompts
28-
├── project-types/ # Domain-specific prompts (9 files)
29-
├── examples/ # Usage examples (5 files)
30-
└── workflows/ # Process guides (2 files)
28+
├── project-types/ # Domain-specific prompts (11 files)
29+
├── examples/ # Usage examples (7 files)
30+
└── workflows/ # Process guides (3 files)
3131
```
3232

3333
## Naming Convention

QUICK-START.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
| Accessibility check | Agent System + **Accessibility Audit** | [View](prompts/english/agents/accessibility-audit-prompt.md) |
2121
| Migration/upgrade | Agent System + **Migration & Upgrade** | [View](prompts/english/agents/migration-upgrade-prompt.md) |
2222
| Set up monitoring | Agent System + **Monitoring & Observability** | [View](prompts/english/agents/monitoring-observability-prompt.md) |
23+
| Production debugging | Agent System + **Debugging & Troubleshooting** | [View](prompts/english/agents/debugging-troubleshooting-prompt.md) |
2324
| Minimal context | **Quick Reference** only | [View](prompts/english/agents/agent-quick-reference.md) |
2425

2526
### Claude Code-Specific
@@ -39,6 +40,10 @@
3940
| Modern full-stack app | **Full-Stack Development** | [View](prompts/english/agents/fullstack-development-prompt.md) |
4041
| Complex multi-step tasks | **Prompt Chaining** | [View](prompts/english/agents/prompt-chaining-prompt.md) |
4142
| Add AI/LLM features | **AI & LLM Integration** | [View](prompts/english/agents/ai-llm-integration-prompt.md) |
43+
| API design / GraphQL | **API Design & GraphQL** | [View](prompts/english/agents/api-design-graphql-prompt.md) |
44+
| Cloud deployment | **Cloud & Infrastructure** | [View](prompts/english/agents/cloud-infrastructure-prompt.md) |
45+
| Data pipelines | **Data Engineering** | [View](prompts/english/agents/data-engineering-prompt.md) |
46+
| Compliance audit | **Compliance & Governance** | [View](prompts/english/agents/compliance-governance-prompt.md) |
4247

4348
### Interactive Sessions
4449

@@ -54,6 +59,8 @@
5459
| General software | Foundation + **General Software** | [View](prompts/english/project-types/general-software-development-prompt.md) |
5560
| Game development | Foundation + **Game Dev** | [View](prompts/english/project-types/game-development-prompt.md) |
5661
| Embedded / IoT | Foundation + **Embedded & IoT** | [View](prompts/english/project-types/embedded-iot-prompt.md) |
62+
| Smart contracts | Foundation + **Blockchain & Web3** | [View](prompts/english/project-types/blockchain-web3-prompt.md) |
63+
| Desktop app | Foundation + **Desktop Apps** | [View](prompts/english/project-types/desktop-development-prompt.md) |
5764
| Full-stack app | Foundation + Web + API ||
5865

5966
---
@@ -98,3 +105,4 @@ All prompts follow this cycle automatically.
98105
- [Prompt Index](prompts/english/INDEX.md) — All prompts by category
99106
- [Prompt Selector](prompts/english/workflows/prompt-selector-guide.md) — Decision tree for choosing prompts
100107
- [Workflow Guide](prompts/english/workflows/iterative-development-guide.md) — APEI deep-dive
108+
- [Troubleshooting Guide](prompts/english/workflows/troubleshooting-guide.md) — Issue diagnosis flowchart

README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,17 @@ Production-ready system prompts for Claude AI and coding agents. Built on the **
1313
| **Project Workflow** | Full lifecycle management | ~2.5K | [View](prompts/english/agents/project-workflow-prompt.md) |
1414
| **Quick Reference** | Cheat sheet (minimal) | ~0.8K | [View](prompts/english/agents/agent-quick-reference.md) |
1515
| **Code Review** | Systematic PR review | ~2K | [View](prompts/english/agents/code-review-prompt.md) |
16-
| **Security Audit** | Vulnerability detection | ~2.5K | [View](prompts/english/agents/security-audit-prompt.md) |
16+
| **Security Audit** | Vulnerability detection + cloud security | ~3.5K | [View](prompts/english/agents/security-audit-prompt.md) |
1717
| **Refactoring** | Code improvement | ~2.5K | [View](prompts/english/agents/refactoring-prompt.md) |
18-
| **Testing** | Test design & TDD | ~3K | [View](prompts/english/agents/testing-strategies-prompt.md) |
18+
| **Testing** | Test design, TDD, chaos & contract testing | ~4K | [View](prompts/english/agents/testing-strategies-prompt.md) |
1919
| **Documentation** | Technical writing | ~2.5K | [View](prompts/english/agents/documentation-prompt.md) |
20-
| **Performance** | Optimization & profiling | ~3K | [View](prompts/english/agents/performance-optimization-prompt.md) |
20+
| **Performance** | Optimization, profiling, CDN & edge | ~3.5K | [View](prompts/english/agents/performance-optimization-prompt.md) |
2121
| **Git & VCS** | Branching & commits | ~2.5K | [View](prompts/english/agents/git-version-control-prompt.md) |
2222
| **Integration Guardian** | System integrity | ~3.5K | [View](prompts/english/agents/integration-guardian-prompt.md) |
2323
| **Accessibility Audit** | WCAG 2.2 compliance | ~3K | [View](prompts/english/agents/accessibility-audit-prompt.md) |
2424
| **Migration & Upgrade** | Framework & DB migrations | ~2.5K | [View](prompts/english/agents/migration-upgrade-prompt.md) |
2525
| **Monitoring & Observability** | Logs, metrics, traces | ~3K | [View](prompts/english/agents/monitoring-observability-prompt.md) |
26+
| **Debugging & Troubleshooting** | Production debugging & incident response | ~3.5K | [View](prompts/english/agents/debugging-troubleshooting-prompt.md) |
2627

2728
### 🎯 Claude Code-Specific Prompts
2829

@@ -37,25 +38,31 @@ Production-ready system prompts for Claude AI and coding agents. Built on the **
3738
| Prompt | Purpose | Tokens | File |
3839
|--------|---------|--------|------|
3940
| **Technology Stack**| Library discovery, modern tools, hidden gems | ~4K | [View](prompts/english/agents/technology-stack-prompt.md) |
40-
| **Architecture Patterns** | System design, microservices, DDD, CQRS | ~3.5K | [View](prompts/english/agents/architecture-patterns-prompt.md) |
41-
| **Full-Stack Development** | Next.js/Nuxt/SvelteKit, end-to-end type safety | ~3.5K | [View](prompts/english/agents/fullstack-development-prompt.md) |
41+
| **Architecture Patterns** | System design, event sourcing, saga, serverless | ~4.5K | [View](prompts/english/agents/architecture-patterns-prompt.md) |
42+
| **Full-Stack Development** | Next.js/Nuxt/SvelteKit, WebSocket, background jobs | ~4.5K | [View](prompts/english/agents/fullstack-development-prompt.md) |
4243
| **Prompt Chaining** | Multi-step workflows, context management | ~3K | [View](prompts/english/agents/prompt-chaining-prompt.md) |
4344
| **AI & LLM Integration** | RAG, vector DBs, AI agents, safety | ~3.5K | [View](prompts/english/agents/ai-llm-integration-prompt.md) |
45+
| **API Design & GraphQL** | Schema-first, DataLoader, caching, contracts | ~4K | [View](prompts/english/agents/api-design-graphql-prompt.md) |
46+
| **Cloud & Infrastructure** | IaC, multi-region, K8s, cost optimization | ~4K | [View](prompts/english/agents/cloud-infrastructure-prompt.md) |
47+
| **Data Engineering** | Pipelines, dbt, streaming, data quality | ~4K | [View](prompts/english/agents/data-engineering-prompt.md) |
48+
| **Compliance & Governance** | GDPR, HIPAA, SOC 2, threat modeling | ~3.5K | [View](prompts/english/agents/compliance-governance-prompt.md) |
4449

4550
### 📋 Foundation & Project Prompts (Interactive Sessions)
4651

4752
| Prompt | Purpose | Technologies | File |
4853
|--------|---------|-------------|------|
4954
| **Foundation**| Universal best practices | Any | [View](prompts/english/base/claude-foundation-prompt.md) |
50-
| **Web Development** | Frontend apps | React, Vue, Angular, CSS | [View](prompts/english/project-types/web-development-prompt.md) |
51-
| **API Development** | Backend services | REST, GraphQL, Node, Go | [View](prompts/english/project-types/api-development-prompt.md) |
52-
| **Data Science & ML** | ML pipelines | Python, pandas, PyTorch | [View](prompts/english/project-types/data-science-ml-prompt.md) |
55+
| **Web Development** | Frontend apps + SEO + a11y | React, Vue, Angular, CSS | [View](prompts/english/project-types/web-development-prompt.md) |
56+
| **API Development** | Backend services + idempotency | REST, GraphQL, Node, Go | [View](prompts/english/project-types/api-development-prompt.md) |
57+
| **Data Science & ML** | ML pipelines + MLOps | Python, pandas, PyTorch | [View](prompts/english/project-types/data-science-ml-prompt.md) |
5358
| **Mobile** | Mobile apps | iOS, Android, Flutter, RN | [View](prompts/english/project-types/mobile-development-prompt.md) |
5459
| **DevOps & CI/CD** | Infrastructure | K8s, Docker, Terraform | [View](prompts/english/project-types/devops-cicd-prompt.md) |
5560
| **Database & SQL** | Data layer | PostgreSQL, MySQL, Redis | [View](prompts/english/project-types/database-sql-prompt.md) |
5661
| **General Software** | Cross-language | Python, JS, Go, Java, C# | [View](prompts/english/project-types/general-software-development-prompt.md) |
5762
| **Game Development** | Game engines | Unity, Unreal, Godot | [View](prompts/english/project-types/game-development-prompt.md) |
5863
| **Embedded & IoT** | Hardware/firmware | C, C++, Rust, FreeRTOS | [View](prompts/english/project-types/embedded-iot-prompt.md) |
64+
| **Blockchain & Web3** | Smart contracts & dApps | Solidity, Rust, Foundry | [View](prompts/english/project-types/blockchain-web3-prompt.md) |
65+
| **Desktop Apps** | Cross-platform desktop | Tauri, Electron, Qt | [View](prompts/english/project-types/desktop-development-prompt.md) |
5966

6067
---
6168

@@ -95,21 +102,26 @@ Production-ready system prompts for Claude AI and coding agents. Built on the **
95102
| Claude Code Setup | Agent System + Workflow & Config |
96103
| Claude Code Planning | Agent System + Mode Transitions |
97104
| Token-Efficient Session | Agent System + Token Optimization |
98-
| Debug / Fix Bugs | Agent System + Error Analysis |
105+
| Debug / Fix Bugs | Agent System + Debugging & Troubleshooting |
106+
| Production Incident | Agent System + Debugging + Monitoring |
99107
| New Project | Agent System + Project Workflow |
100108
| Choose Best Tools | Agent System + Technology Stack |
101109
| System Architecture | Agent System + Architecture Patterns |
102110
| Full-Stack App (modern) | Agent System + Full-Stack Development |
111+
| API Design (GraphQL) | Agent System + API Design & GraphQL |
103112
| Complex Multi-Step Task | Agent System + Prompt Chaining |
104113
| Add AI/LLM Features | Agent System + AI & LLM Integration |
105114
| Code Review | Agent System + Code Review |
106115
| Security Check | Agent System + Security Audit |
116+
| Compliance Audit | Agent System + Compliance & Governance |
107117
| Accessibility Check | Agent System + Accessibility Audit |
108118
| Reduce Tech Debt | Agent System + Refactoring |
109119
| Framework/DB Migration | Agent System + Migration & Upgrade |
110120
| Write Tests | Agent System + Testing |
111121
| Write Docs | Agent System + Documentation |
112122
| Optimize Speed | Agent System + Performance |
123+
| Cloud Deployment | Agent System + Cloud & Infrastructure |
124+
| Data Pipelines | Agent System + Data Engineering |
113125
| Set Up Monitoring | Agent System + Monitoring & Observability |
114126
| Git Workflow | Agent System + Git & VCS |
115127
| Cross-Cutting Integrity | Agent System + Integration Guardian |
@@ -122,6 +134,8 @@ Production-ready system prompts for Claude AI and coding agents. Built on the **
122134
| General Software | Foundation + General Software |
123135
| Game Development | Foundation + Game Development |
124136
| Embedded / IoT | Foundation + Embedded & IoT |
137+
| Smart Contracts | Foundation + Blockchain & Web3 |
138+
| Desktop App | Foundation + Desktop Apps |
125139

126140
---
127141

@@ -130,11 +144,11 @@ Production-ready system prompts for Claude AI and coding agents. Built on the **
130144
```
131145
prompts/
132146
└── english/
133-
├── agents/ # Agent-optimized prompts (23 files)
147+
├── agents/ # Agent-optimized prompts (28 files)
134148
├── base/ # Foundation prompt
135-
├── project-types/ # Domain-specific prompts (9 files)
136-
├── examples/ # Real-world usage examples (5 files)
137-
└── workflows/ # APEI methodology & prompt selection guides
149+
├── project-types/ # Domain-specific prompts (11 files)
150+
├── examples/ # Real-world usage examples (7 files)
151+
└── workflows/ # APEI methodology, prompt selection & troubleshooting guides
138152
```
139153

140154
## Resources
@@ -150,6 +164,7 @@ prompts/
150164
| [Prompt Index](prompts/english/INDEX.md) | All prompts organized by category |
151165
| [Prompt Selector](prompts/english/workflows/prompt-selector-guide.md) | Decision tree for choosing prompts |
152166
| [Workflow Guide](prompts/english/workflows/iterative-development-guide.md) | APEI methodology deep-dive |
167+
| [Troubleshooting Guide](prompts/english/workflows/troubleshooting-guide.md) | Issue diagnosis & resolution flowchart |
153168

154169
## Customization
155170

0 commit comments

Comments
 (0)