domain-template
starsforks
How to install domain-template?
sordi-ai/skill-everything/domain-template
$npx -y skills add sordi-ai/skill-everything --skill domain-templateApply when documenting project-specific knowledge. Template for ADRs, naming conventions, business rules, and tech-stack quirks.
SKILL.md
| 1 | # Sub-Skill: Domain Knowledge Template |
| 2 | <!-- target: ~850 tokens (empty template — grows when filled in for your project) --> |
| 3 | |
| 4 | **Purpose:** Structured template for capturing company- or project-specific knowledge |
| 5 | that no public model can know — architecture decisions, naming conventions, business rules. |
| 6 | |
| 7 | --- |
| 8 | |
| 9 | ## Instructions: Fill Out This Template |
| 10 | |
| 11 | Copy this file to `skills/<project-name>/SKILL.md` and fill in all sections. |
| 12 | Delete empty sections. Concrete > comprehensive. |
| 13 | |
| 14 | --- |
| 15 | |
| 16 | ## Project Overview |
| 17 | |
| 18 | ``` |
| 19 | Project name: [e.g. "OrderFlow"] |
| 20 | Technology: [e.g. "Node.js 20, PostgreSQL 15, React 18"] |
| 21 | Deployment: [e.g. "AWS ECS, GitHub Actions CI/CD"] |
| 22 | Team size: [e.g. "4 backend, 2 frontend"] |
| 23 | Main repo: [e.g. "github.com/acme/orderflow"] |
| 24 | ``` |
| 25 | |
| 26 | --- |
| 27 | |
| 28 | ## Architecture Decision Records (ADRs) |
| 29 | |
| 30 | ### ADR-001: [Title] |
| 31 | - **Date:** YYYY-MM-DD |
| 32 | - **Status:** Accepted / Deprecated / Superseded by ADR-XXX |
| 33 | - **Context:** Why did a decision need to be made? |
| 34 | - **Decision:** What was decided? |
| 35 | - **Consequences:** What changes as a result? |
| 36 | |
| 37 | --- |
| 38 | |
| 39 | ## Naming Conventions |
| 40 | |
| 41 | | Context | Convention | Example | |
| 42 | |---------|-----------|---------| |
| 43 | | Database tables | snake_case, plural | `order_items` | |
| 44 | | API endpoints | kebab-case, plural | `/api/order-items` | |
| 45 | | TypeScript interfaces | PascalCase, no `I` prefix | `OrderItem` | |
| 46 | | Environment variables | SCREAMING_SNAKE_CASE | `DATABASE_URL` | |
| 47 | | React components | PascalCase | `OrderItemList` | |
| 48 | |
| 49 | --- |
| 50 | |
| 51 | ## Business Rules |
| 52 | |
| 53 | > These rules are not documented in the code — only here. |
| 54 | |
| 55 | 1. **[Rule name]:** [Description]. Example: `Orders under $10 have no shipping costs.` |
| 56 | 2. **[Rule name]:** [Description]. |
| 57 | |
| 58 | --- |
| 59 | |
| 60 | ## Known Pitfalls |
| 61 | |
| 62 | 1. **[Pitfall]:** [What happens and why]. Example: `The users table has two ID fields: id (internal) and external_id (customer number). Never confuse them.` |
| 63 | 2. **[Pitfall]:** [What happens and why]. |
| 64 | |
| 65 | --- |
| 66 | |
| 67 | ## External Systems & Integrations |
| 68 | |
| 69 | | System | Purpose | Auth Method | Contact for Issues | |
| 70 | |--------|---------|-------------|-------------------| |
| 71 | | Stripe | Payments | API key in `STRIPE_SECRET_KEY` | payments@acme.com | |
| 72 | | SendGrid | Emails | API key in `SENDGRID_API_KEY` | devops@acme.com | |
| 73 | |
| 74 | --- |
| 75 | |
| 76 | ## Glossary |
| 77 | |
| 78 | | Term | Meaning | |
| 79 | |------|---------| |
| 80 | | `Order` | A confirmed order (status >= CONFIRMED) | |
| 81 | | `Cart` | An unconfirmed order (status = DRAFT) | |
| 82 | |
| 83 | --- |
| 84 | |
| 85 | ## Agent Directives |
| 86 | |
| 87 | > Specific instructions for how the agent should work in this project. |
| 88 | |
| 89 | 1. **[Directive]:** [Description]. Example: `Never delete files without explicit user confirmation.` |
| 90 | 2. **[Directive]:** [Description]. Example: `Always output the full file path with every change.` |
| 91 | 3. **[Directive]:** [Description]. Example: `Always use English in commit messages.` |
| 92 | |
| 93 | --- |
| 94 | |
| 95 | ## Tech Stack Quirks |
| 96 | |
| 97 | > Stack-specific gotchas not found in the documentation — only learned through experience. |
| 98 | |
| 99 | 1. **[Quirk name]:** [What happens and why]. Example: `Prisma Client must be regenerated with npx prisma generate after schema changes — a simple npm install is not enough.` |
| 100 | 2. **[Quirk name]:** [What happens and why]. Example: `The Redis connection pool in production has max 10 connections — with more than 10 parallel requests, requests get dropped.` |
| 101 | |
| 102 | --- |
| 103 | |
| 104 | ## Why This Sub-Skill Earns Stars |
| 105 | |
| 106 | Without domain knowledge, the agent makes plausible but wrong assumptions about naming, business rules, and architecture. |
| 107 | With this template filled out once → the agent knows the project like a team member. |
People who liked this also viewed
6 picksType
- find-skillsHelps users discover and install agent skills when they ask questions like "how do I do X", "find a skill for X", "is there a skill that can...", or express interest in extending capabilities. This skSkillsJul 2026
- grill-meA relentless interview to sharpen a plan or design.SkillsJul 2026
- vercel-react-best-practicesVercel's official collection of agent skillsSkillsJul 2026
- improve-codebase-architectureScan a codebase for deepening opportunities, present them as a visual HTML report, then grill through whichever one you pick.SkillsJul 2026
- setup-matt-pocock-skillsConfigure this repo for the engineering skills — set up its issue tracker, triage label vocabulary, and domain doc layout. Run once before first use of the other engineering skills.SkillsJul 2026
- triageMove issues and external PRs through a state machine of triage roles — categorise, verify, grill if needed, and write agent-ready briefs.SkillsJul 2026
