docs: update visual guide and skill anatomy for V3 specs [skip ci]

This commit is contained in:
sck_0
2026-01-25 20:25:44 +01:00
parent c0348ca1b5
commit 0f4a1b2fd7
2 changed files with 91 additions and 23 deletions

View File

@@ -31,6 +31,7 @@ skills/
Every `SKILL.md` file has two main parts: Every `SKILL.md` file has two main parts:
### 1. Frontmatter (Metadata) ### 1. Frontmatter (Metadata)
### 2. Content (Instructions) ### 2. Content (Instructions)
Let's break down each part: Let's break down each part:
@@ -51,12 +52,14 @@ description: "Brief description of what this skill does"
### Required Fields ### Required Fields
#### `name` #### `name`
- **What it is:** The skill's identifier - **What it is:** The skill's identifier
- **Format:** lowercase-with-hyphens - **Format:** lowercase-with-hyphens
- **Must match:** The folder name exactly - **Must match:** The folder name exactly
- **Example:** `stripe-integration` - **Example:** `stripe-integration`
#### `description` #### `description`
- **What it is:** One-sentence summary - **What it is:** One-sentence summary
- **Format:** String in quotes - **Format:** String in quotes
- **Length:** Keep it under 150 characters - **Length:** Keep it under 150 characters
@@ -70,9 +73,9 @@ Some skills include additional metadata:
--- ---
name: my-skill-name name: my-skill-name
description: "Brief description" description: "Brief description"
version: "1.0.0" risk: "safe" # safe | risk | official
author: "Your Name" source: "community"
tags: ["react", "typescript", "testing"] tags: ["react", "typescript"]
--- ---
``` ```
@@ -85,13 +88,16 @@ After the frontmatter comes the actual skill content. Here's the recommended str
### Recommended Sections ### Recommended Sections
#### 1. Title (H1) #### 1. Title (H1)
```markdown ```markdown
# Skill Title # Skill Title
``` ```
- Use a clear, descriptive title - Use a clear, descriptive title
- Usually matches or expands on the skill name - Usually matches or expands on the skill name
#### 2. Overview #### 2. Overview
```markdown ```markdown
## Overview ## Overview
@@ -100,6 +106,7 @@ A brief explanation of what this skill does and why it exists.
``` ```
#### 3. When to Use #### 3. When to Use
```markdown ```markdown
## When to Use This Skill ## When to Use This Skill
@@ -111,28 +118,34 @@ A brief explanation of what this skill does and why it exists.
**Why this matters:** Helps the AI know when to activate this skill **Why this matters:** Helps the AI know when to activate this skill
#### 4. Core Instructions #### 4. Core Instructions
```markdown ```markdown
## How It Works ## How It Works
### Step 1: [Action] ### Step 1: [Action]
Detailed instructions... Detailed instructions...
### Step 2: [Action] ### Step 2: [Action]
More instructions... More instructions...
``` ```
**This is the heart of your skill** - clear, actionable steps **This is the heart of your skill** - clear, actionable steps
#### 5. Examples #### 5. Examples
```markdown ```markdown
## Examples ## Examples
### Example 1: [Use Case] ### Example 1: [Use Case]
\`\`\`javascript \`\`\`javascript
// Example code // Example code
\`\`\` \`\`\`
### Example 2: [Another Use Case] ### Example 2: [Another Use Case]
\`\`\`javascript \`\`\`javascript
// More code // More code
\`\`\` \`\`\`
@@ -141,6 +154,7 @@ More instructions...
**Why examples matter:** They show the AI exactly what good output looks like **Why examples matter:** They show the AI exactly what good output looks like
#### 6. Best Practices #### 6. Best Practices
```markdown ```markdown
## Best Practices ## Best Practices
@@ -151,6 +165,7 @@ More instructions...
``` ```
#### 7. Common Pitfalls #### 7. Common Pitfalls
```markdown ```markdown
## Common Pitfalls ## Common Pitfalls
@@ -159,6 +174,7 @@ More instructions...
``` ```
#### 8. Related Skills #### 8. Related Skills
```markdown ```markdown
## Related Skills ## Related Skills
@@ -173,11 +189,13 @@ More instructions...
### Use Clear, Direct Language ### Use Clear, Direct Language
**❌ Bad:** **❌ Bad:**
```markdown ```markdown
You might want to consider possibly checking if the user has authentication. You might want to consider possibly checking if the user has authentication.
``` ```
**✅ Good:** **✅ Good:**
```markdown ```markdown
Check if the user is authenticated before proceeding. Check if the user is authenticated before proceeding.
``` ```
@@ -185,11 +203,13 @@ Check if the user is authenticated before proceeding.
### Use Action Verbs ### Use Action Verbs
**❌ Bad:** **❌ Bad:**
```markdown ```markdown
The file should be created... The file should be created...
``` ```
**✅ Good:** **✅ Good:**
```markdown ```markdown
Create the file... Create the file...
``` ```
@@ -197,11 +217,13 @@ Create the file...
### Be Specific ### Be Specific
**❌ Bad:** **❌ Bad:**
```markdown ```markdown
Set up the database properly. Set up the database properly.
``` ```
**✅ Good:** **✅ Good:**
```markdown ```markdown
1. Create a PostgreSQL database 1. Create a PostgreSQL database
2. Run migrations: `npm run migrate` 2. Run migrations: `npm run migrate`
@@ -224,6 +246,7 @@ scripts/
``` ```
**Reference them in SKILL.md:** **Reference them in SKILL.md:**
```markdown ```markdown
Run the setup script: Run the setup script:
\`\`\`bash \`\`\`bash
@@ -256,6 +279,7 @@ templates/
``` ```
**Reference in SKILL.md:** **Reference in SKILL.md:**
```markdown ```markdown
Use this template as a starting point: Use this template as a starting point:
\`\`\`typescript \`\`\`typescript
@@ -279,16 +303,19 @@ references/
## Skill Size Guidelines ## Skill Size Guidelines
### Minimum Viable Skill ### Minimum Viable Skill
- **Frontmatter:** name + description - **Frontmatter:** name + description
- **Content:** 100-200 words - **Content:** 100-200 words
- **Sections:** Overview + Instructions - **Sections:** Overview + Instructions
### Standard Skill ### Standard Skill
- **Frontmatter:** name + description - **Frontmatter:** name + description
- **Content:** 300-800 words - **Content:** 300-800 words
- **Sections:** Overview + When to Use + Instructions + Examples - **Sections:** Overview + When to Use + Instructions + Examples
### Comprehensive Skill ### Comprehensive Skill
- **Frontmatter:** name + description + optional fields - **Frontmatter:** name + description + optional fields
- **Content:** 800-2000 words - **Content:** 800-2000 words
- **Sections:** All recommended sections - **Sections:** All recommended sections
@@ -303,7 +330,9 @@ references/
### Use Markdown Effectively ### Use Markdown Effectively
#### Code Blocks #### Code Blocks
Always specify the language: Always specify the language:
```markdown ```markdown
\`\`\`javascript \`\`\`javascript
const example = "code"; const example = "code";
@@ -311,7 +340,9 @@ const example = "code";
``` ```
#### Lists #### Lists
Use consistent formatting: Use consistent formatting:
```markdown ```markdown
- Item 1 - Item 1
- Item 2 - Item 2
@@ -320,11 +351,13 @@ Use consistent formatting:
``` ```
#### Emphasis #### Emphasis
- **Bold** for important terms: `**important**` - **Bold** for important terms: `**important**`
- *Italic* for emphasis: `*emphasis*` - _Italic_ for emphasis: `*emphasis*`
- `Code` for commands/code: `` `code` `` - `Code` for commands/code: `` `code` ``
#### Links #### Links
```markdown ```markdown
[Link text](https://example.com) [Link text](https://example.com)
``` ```
@@ -336,24 +369,28 @@ Use consistent formatting:
Before finalizing your skill: Before finalizing your skill:
### Content Quality ### Content Quality
- [ ] Instructions are clear and actionable - [ ] Instructions are clear and actionable
- [ ] Examples are realistic and helpful - [ ] Examples are realistic and helpful
- [ ] No typos or grammar errors - [ ] No typos or grammar errors
- [ ] Technical accuracy verified - [ ] Technical accuracy verified
### Structure ### Structure
- [ ] Frontmatter is valid YAML - [ ] Frontmatter is valid YAML
- [ ] Name matches folder name - [ ] Name matches folder name
- [ ] Sections are logically organized - [ ] Sections are logically organized
- [ ] Headings follow hierarchy (H1 → H2 → H3) - [ ] Headings follow hierarchy (H1 → H2 → H3)
### Completeness ### Completeness
- [ ] Overview explains the "why" - [ ] Overview explains the "why"
- [ ] Instructions explain the "how" - [ ] Instructions explain the "how"
- [ ] Examples show the "what" - [ ] Examples show the "what"
- [ ] Edge cases are addressed - [ ] Edge cases are addressed
### Usability ### Usability
- [ ] A beginner could follow this - [ ] A beginner could follow this
- [ ] An expert would find it useful - [ ] An expert would find it useful
- [ ] The AI can parse it correctly - [ ] The AI can parse it correctly
@@ -373,6 +410,7 @@ description: "You MUST use this before any creative work..."
``` ```
**Analysis:** **Analysis:**
- ✅ Clear name - ✅ Clear name
- ✅ Strong description with urgency ("MUST use") - ✅ Strong description with urgency ("MUST use")
- ✅ Explains when to use it - ✅ Explains when to use it
@@ -381,10 +419,12 @@ description: "You MUST use this before any creative work..."
# Brainstorming Ideas Into Designs # Brainstorming Ideas Into Designs
## Overview ## Overview
Help turn ideas into fully formed designs... Help turn ideas into fully formed designs...
``` ```
**Analysis:** **Analysis:**
- ✅ Clear title - ✅ Clear title
- ✅ Concise overview - ✅ Concise overview
- ✅ Explains the value proposition - ✅ Explains the value proposition
@@ -393,11 +433,13 @@ Help turn ideas into fully formed designs...
## The Process ## The Process
**Understanding the idea:** **Understanding the idea:**
- Check out the current project state first - Check out the current project state first
- Ask questions one at a time - Ask questions one at a time
``` ```
**Analysis:** **Analysis:**
- ✅ Broken into clear phases - ✅ Broken into clear phases
- ✅ Specific, actionable steps - ✅ Specific, actionable steps
- ✅ Easy to follow - ✅ Easy to follow
@@ -412,10 +454,12 @@ Help turn ideas into fully formed designs...
## Instructions ## Instructions
If the user is working with React: If the user is working with React:
- Use functional components - Use functional components
- Prefer hooks over class components - Prefer hooks over class components
If the user is working with Vue: If the user is working with Vue:
- Use Composition API - Use Composition API
- Follow Vue 3 patterns - Follow Vue 3 patterns
``` ```
@@ -424,9 +468,11 @@ If the user is working with Vue:
```markdown ```markdown
## Basic Usage ## Basic Usage
[Simple instructions for common cases] [Simple instructions for common cases]
## Advanced Usage ## Advanced Usage
[Complex patterns for power users] [Complex patterns for power users]
``` ```
@@ -447,15 +493,18 @@ If the user is working with Vue:
How to know if your skill is good: How to know if your skill is good:
### Clarity Test ### Clarity Test
- Can someone unfamiliar with the topic follow it? - Can someone unfamiliar with the topic follow it?
- Are there any ambiguous instructions? - Are there any ambiguous instructions?
### Completeness Test ### Completeness Test
- Does it cover the happy path? - Does it cover the happy path?
- Does it handle edge cases? - Does it handle edge cases?
- Are error scenarios addressed? - Are error scenarios addressed?
### Usefulness Test ### Usefulness Test
- Does it solve a real problem? - Does it solve a real problem?
- Would you use this yourself? - Would you use this yourself?
- Does it save time or improve quality? - Does it save time or improve quality?
@@ -467,11 +516,13 @@ How to know if your skill is good:
### Study These Examples ### Study These Examples
**For Beginners:** **For Beginners:**
- `skills/brainstorming/SKILL.md` - Clear structure - `skills/brainstorming/SKILL.md` - Clear structure
- `skills/git-pushing/SKILL.md` - Simple and focused - `skills/git-pushing/SKILL.md` - Simple and focused
- `skills/copywriting/SKILL.md` - Good examples - `skills/copywriting/SKILL.md` - Good examples
**For Advanced:** **For Advanced:**
- `skills/systematic-debugging/SKILL.md` - Comprehensive - `skills/systematic-debugging/SKILL.md` - Comprehensive
- `skills/react-best-practices/SKILL.md` - Multiple files - `skills/react-best-practices/SKILL.md` - Multiple files
- `skills/loki-mode/SKILL.md` - Complex workflows - `skills/loki-mode/SKILL.md` - Complex workflows
@@ -491,22 +542,28 @@ How to know if your skill is good:
## Common Mistakes to Avoid ## Common Mistakes to Avoid
### ❌ Mistake 1: Too Vague ### ❌ Mistake 1: Too Vague
```markdown ```markdown
## Instructions ## Instructions
Make the code better. Make the code better.
``` ```
**✅ Fix:** **✅ Fix:**
```markdown ```markdown
## Instructions ## Instructions
1. Extract repeated logic into functions 1. Extract repeated logic into functions
2. Add error handling for edge cases 2. Add error handling for edge cases
3. Write unit tests for core functionality 3. Write unit tests for core functionality
``` ```
### ❌ Mistake 2: Too Complex ### ❌ Mistake 2: Too Complex
```markdown ```markdown
## Instructions ## Instructions
[5000 words of dense technical jargon] [5000 words of dense technical jargon]
``` ```
@@ -514,8 +571,10 @@ Make the code better.
Break into multiple skills or use progressive disclosure Break into multiple skills or use progressive disclosure
### ❌ Mistake 3: No Examples ### ❌ Mistake 3: No Examples
```markdown ```markdown
## Instructions ## Instructions
[Instructions without any code examples] [Instructions without any code examples]
``` ```
@@ -523,6 +582,7 @@ Break into multiple skills or use progressive disclosure
Add at least 2-3 realistic examples Add at least 2-3 realistic examples
### ❌ Mistake 4: Outdated Information ### ❌ Mistake 4: Outdated Information
```markdown ```markdown
Use React class components... Use React class components...
``` ```

View File

@@ -32,9 +32,10 @@ antigravity-awesome-skills/
├── 📄 README.md ← Overview & skill list ├── 📄 README.md ← Overview & skill list
├── 📄 GETTING_STARTED.md ← Start here! (NEW) ├── 📄 GETTING_STARTED.md ← Start here! (NEW)
├── 📄 CONTRIBUTING.md ← How to contribute (NEW) ├── 📄 CONTRIBUTING.md ← How to contribute
├── 📄 FAQ.md ← Troubleshooting
├── 📁 skills/ ← All 179 skills live here ├── 📁 skills/ ← All 250+ skills live here
│ │ │ │
│ ├── 📁 brainstorming/ │ ├── 📁 brainstorming/
│ │ └── 📄 SKILL.md ← Skill definition │ │ └── 📄 SKILL.md ← Skill definition
@@ -43,20 +44,20 @@ antigravity-awesome-skills/
│ │ ├── 📄 SKILL.md │ │ ├── 📄 SKILL.md
│ │ └── 📁 examples/ ← Optional extras │ │ └── 📁 examples/ ← Optional extras
│ │ │ │
── 📁 react-best-practices/ ── ... (250+ more skills)
│ │ ├── 📄 SKILL.md
│ │ ├── 📁 rules/
│ │ └── 📄 README.md
│ │
│ └── ... (176 more skills)
├── 📁 scripts/ ← Validation & management ├── 📁 scripts/ ← Validation & management
│ ├── validate_skills.py │ ├── validate_skills.py ← Quality Bar Enforcer
│ └── generate_index.py │ └── generate_index.py ← Registry Generator
── 📁 docs/ ← Documentation (NEW) ── 📁 .github/
│ └── 📄 MAINTENANCE.md ← Maintainers Guide
└── 📁 docs/ ← Documentation
├── 📄 BUNDLES.md ← Starter Packs (NEW)
├── 📄 QUALITY_BAR.md ← Quality Standards
├── 📄 SKILL_ANATOMY.md ← How skills work ├── 📄 SKILL_ANATOMY.md ← How skills work
└── 📄 VISUAL_GUIDE.md ← This file! └── 📄 VISUAL_GUIDE.md ← This file!
``` ```
--- ---
@@ -95,7 +96,7 @@ antigravity-awesome-skills/
``` ```
┌─────────────────────────┐ ┌─────────────────────────┐
179 AWESOME SKILLS 250+ AWESOME SKILLS │
└────────────┬────────────┘ └────────────┬────────────┘
┌────────────────────────┼────────────────────────┐ ┌────────────────────────┼────────────────────────┐
@@ -129,7 +130,7 @@ antigravity-awesome-skills/
## Skill File Anatomy (Visual) ## Skill File Anatomy (Visual)
``` ````
┌─────────────────────────────────────────────────────────┐ ┌─────────────────────────────────────────────────────────┐
│ SKILL.md │ │ SKILL.md │
├─────────────────────────────────────────────────────────┤ ├─────────────────────────────────────────────────────────┤
@@ -167,13 +168,14 @@ antigravity-awesome-skills/
│ └───────────────────────────────────────────────┘ │ │ └───────────────────────────────────────────────┘ │
│ │ │ │
└─────────────────────────────────────────────────────────┘ └─────────────────────────────────────────────────────────┘
``` ````
--- ---
## Installation (Visual Steps) ## Installation (Visual Steps)
### Step 1: Clone the Repository ### Step 1: Clone the Repository
``` ```
┌─────────────────────────────────────────┐ ┌─────────────────────────────────────────┐
│ Terminal │ │ Terminal │
@@ -188,6 +190,7 @@ antigravity-awesome-skills/
``` ```
### Step 2: Verify Installation ### Step 2: Verify Installation
``` ```
┌─────────────────────────────────────────┐ ┌─────────────────────────────────────────┐
│ File Explorer │ │ File Explorer │
@@ -202,6 +205,7 @@ antigravity-awesome-skills/
``` ```
### Step 3: Use a Skill ### Step 3: Use a Skill
``` ```
┌─────────────────────────────────────────┐ ┌─────────────────────────────────────────┐
│ AI Assistant Chat │ │ AI Assistant Chat │
@@ -271,16 +275,19 @@ antigravity-awesome-skills/
## Finding Skills (Visual Guide) ## Finding Skills (Visual Guide)
### Method 1: Browse by Category ### Method 1: Browse by Category
``` ```
README.md → Scroll to "Full Skill Registry" → Find category → Pick skill README.md → Scroll to "Full Skill Registry" → Find category → Pick skill
``` ```
### Method 2: Search by Keyword ### Method 2: Search by Keyword
``` ```
Terminal → ls skills/ | grep "keyword" → See matching skills Terminal → ls skills/ | grep "keyword" → See matching skills
``` ```
### Method 3: Use the Index ### Method 3: Use the Index
``` ```
Open skills_index.json → Search for keyword → Find skill path Open skills_index.json → Search for keyword → Find skill path
``` ```
@@ -465,19 +472,19 @@ START HERE
Day 1: Install skills Day 1: Install skills
└─→ "Wow, @brainstorming helped me design my app!" └─→ "Wow, @brainstorming helped me design my app!"
Day 3: Use 5 different skills Day 3: Use 5 different skills
└─→ "These skills save me so much time!" └─→ "These skills save me so much time!"
Week 1: Create first skill Week 1: Create first skill
└─→ "I shared my expertise as a skill!" └─→ "I shared my expertise as a skill!"
Week 2: Skill gets merged Week 2: Skill gets merged
└─→ "My skill is helping others! 🎉" └─→ "My skill is helping others! 🎉"
Month 1: Regular contributor Month 1: Regular contributor
└─→ "I've contributed 5 skills and improved docs!" └─→ "I've contributed 5 skills and improved docs!"
@@ -497,6 +504,7 @@ Month 1: Regular contributor
--- ---
**Visual learner?** This guide should help! Still have questions? Check out: **Visual learner?** This guide should help! Still have questions? Check out:
- [GETTING_STARTED.md](../GETTING_STARTED.md) - Text-based intro - [GETTING_STARTED.md](../GETTING_STARTED.md) - Text-based intro
- [SKILL_ANATOMY.md](SKILL_ANATOMY.md) - Detailed breakdown - [SKILL_ANATOMY.md](SKILL_ANATOMY.md) - Detailed breakdown
- [CONTRIBUTING.md](../CONTRIBUTING.md) - How to contribute - [CONTRIBUTING.md](../CONTRIBUTING.md) - How to contribute