d1337-kit 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agent/.shared/ui-ux-pro-max/data/charts.csv +26 -0
- package/.agent/.shared/ui-ux-pro-max/data/colors.csv +97 -0
- package/.agent/.shared/ui-ux-pro-max/data/icons.csv +101 -0
- package/.agent/.shared/ui-ux-pro-max/data/landing.csv +31 -0
- package/.agent/.shared/ui-ux-pro-max/data/products.csv +97 -0
- package/.agent/.shared/ui-ux-pro-max/data/prompts.csv +24 -0
- package/.agent/.shared/ui-ux-pro-max/data/react-performance.csv +45 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/flutter.csv +53 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/nextjs.csv +53 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/react-native.csv +52 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/react.csv +54 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/shadcn.csv +61 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/svelte.csv +54 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/swiftui.csv +51 -0
- package/.agent/.shared/ui-ux-pro-max/data/stacks/vue.csv +50 -0
- package/.agent/.shared/ui-ux-pro-max/data/styles.csv +59 -0
- package/.agent/.shared/ui-ux-pro-max/data/typography.csv +58 -0
- package/.agent/.shared/ui-ux-pro-max/data/ui-reasoning.csv +101 -0
- package/.agent/.shared/ui-ux-pro-max/data/ux-guidelines.csv +100 -0
- package/.agent/.shared/ui-ux-pro-max/data/web-interface.csv +31 -0
- package/.agent/.shared/ui-ux-pro-max/scripts/__pycache__/core.cpython-313.pyc +0 -0
- package/.agent/.shared/ui-ux-pro-max/scripts/__pycache__/design_system.cpython-313.pyc +0 -0
- package/.agent/.shared/ui-ux-pro-max/scripts/core.py +258 -0
- package/.agent/.shared/ui-ux-pro-max/scripts/design_system.py +1067 -0
- package/.agent/.shared/ui-ux-pro-max/scripts/search.py +106 -0
- package/.agent/ARCHITECTURE.md +288 -0
- package/.agent/agents/backend-specialist.md +240 -0
- package/.agent/agents/code-archaeologist.md +104 -0
- package/.agent/agents/database-architect.md +224 -0
- package/.agent/agents/debugger.md +225 -0
- package/.agent/agents/devops-engineer.md +238 -0
- package/.agent/agents/documentation-writer.md +102 -0
- package/.agent/agents/explorer-agent.md +76 -0
- package/.agent/agents/frontend-specialist.md +595 -0
- package/.agent/agents/game-developer.md +160 -0
- package/.agent/agents/mobile-developer.md +377 -0
- package/.agent/agents/orchestrator.md +418 -0
- package/.agent/agents/penetration-tester.md +370 -0
- package/.agent/agents/performance-optimizer.md +185 -0
- package/.agent/agents/product-manager.md +110 -0
- package/.agent/agents/product-owner.md +93 -0
- package/.agent/agents/project-planner.md +408 -0
- package/.agent/agents/qa-automation-engineer.md +101 -0
- package/.agent/agents/security-auditor.md +251 -0
- package/.agent/agents/seo-specialist.md +109 -0
- package/.agent/agents/test-engineer.md +156 -0
- package/.agent/mcp_config.json +25 -0
- package/.agent/modules/README.md +74 -0
- package/.agent/modules/installed/README.md +9 -0
- package/.agent/modules/module-template/SKILL.md +40 -0
- package/.agent/modules/module-template/scripts/README.md +11 -0
- package/.agent/modules/registry.md +34 -0
- package/.agent/rules/GEMINI.md +206 -0
- package/.agent/scripts/auto_preview.py +148 -0
- package/.agent/scripts/checklist.py +217 -0
- package/.agent/scripts/session_manager.py +120 -0
- package/.agent/scripts/verify_all.py +327 -0
- package/.agent/skills/api-patterns/SKILL.md +81 -0
- package/.agent/skills/api-patterns/api-style.md +42 -0
- package/.agent/skills/api-patterns/auth.md +24 -0
- package/.agent/skills/api-patterns/documentation.md +26 -0
- package/.agent/skills/api-patterns/graphql.md +41 -0
- package/.agent/skills/api-patterns/rate-limiting.md +31 -0
- package/.agent/skills/api-patterns/response.md +37 -0
- package/.agent/skills/api-patterns/rest.md +40 -0
- package/.agent/skills/api-patterns/scripts/api_validator.py +211 -0
- package/.agent/skills/api-patterns/security-testing.md +122 -0
- package/.agent/skills/api-patterns/trpc.md +41 -0
- package/.agent/skills/api-patterns/versioning.md +22 -0
- package/.agent/skills/app-builder/SKILL.md +75 -0
- package/.agent/skills/app-builder/agent-coordination.md +71 -0
- package/.agent/skills/app-builder/feature-building.md +53 -0
- package/.agent/skills/app-builder/project-detection.md +34 -0
- package/.agent/skills/app-builder/scaffolding.md +118 -0
- package/.agent/skills/app-builder/tech-stack.md +41 -0
- package/.agent/skills/app-builder/templates/SKILL.md +39 -0
- package/.agent/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/.agent/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/.agent/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/.agent/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/.agent/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/.agent/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/.agent/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/.agent/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -0
- package/.agent/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -0
- package/.agent/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -0
- package/.agent/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -0
- package/.agent/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/.agent/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -0
- package/.agent/skills/architecture/SKILL.md +55 -0
- package/.agent/skills/architecture/context-discovery.md +43 -0
- package/.agent/skills/architecture/examples.md +94 -0
- package/.agent/skills/architecture/pattern-selection.md +68 -0
- package/.agent/skills/architecture/patterns-reference.md +50 -0
- package/.agent/skills/architecture/trade-off-analysis.md +77 -0
- package/.agent/skills/bash-linux/SKILL.md +199 -0
- package/.agent/skills/behavioral-modes/SKILL.md +242 -0
- package/.agent/skills/brainstorming/SKILL.md +163 -0
- package/.agent/skills/brainstorming/dynamic-questioning.md +350 -0
- package/.agent/skills/clean-code/SKILL.md +201 -0
- package/.agent/skills/code-review-checklist/SKILL.md +109 -0
- package/.agent/skills/database-design/SKILL.md +52 -0
- package/.agent/skills/database-design/database-selection.md +43 -0
- package/.agent/skills/database-design/indexing.md +39 -0
- package/.agent/skills/database-design/migrations.md +48 -0
- package/.agent/skills/database-design/optimization.md +36 -0
- package/.agent/skills/database-design/orm-selection.md +30 -0
- package/.agent/skills/database-design/schema-design.md +56 -0
- package/.agent/skills/database-design/scripts/schema_validator.py +172 -0
- package/.agent/skills/deployment-procedures/SKILL.md +241 -0
- package/.agent/skills/doc.md +177 -0
- package/.agent/skills/documentation-templates/SKILL.md +194 -0
- package/.agent/skills/frontend-design/SKILL.md +452 -0
- package/.agent/skills/frontend-design/animation-guide.md +331 -0
- package/.agent/skills/frontend-design/color-system.md +311 -0
- package/.agent/skills/frontend-design/decision-trees.md +418 -0
- package/.agent/skills/frontend-design/motion-graphics.md +306 -0
- package/.agent/skills/frontend-design/scripts/accessibility_checker.py +183 -0
- package/.agent/skills/frontend-design/scripts/ux_audit.py +722 -0
- package/.agent/skills/frontend-design/typography-system.md +345 -0
- package/.agent/skills/frontend-design/ux-psychology.md +1116 -0
- package/.agent/skills/frontend-design/visual-effects.md +383 -0
- package/.agent/skills/game-development/2d-games/SKILL.md +119 -0
- package/.agent/skills/game-development/3d-games/SKILL.md +135 -0
- package/.agent/skills/game-development/SKILL.md +167 -0
- package/.agent/skills/game-development/game-art/SKILL.md +185 -0
- package/.agent/skills/game-development/game-audio/SKILL.md +190 -0
- package/.agent/skills/game-development/game-design/SKILL.md +129 -0
- package/.agent/skills/game-development/mobile-games/SKILL.md +108 -0
- package/.agent/skills/game-development/multiplayer/SKILL.md +132 -0
- package/.agent/skills/game-development/pc-games/SKILL.md +144 -0
- package/.agent/skills/game-development/vr-ar/SKILL.md +123 -0
- package/.agent/skills/game-development/web-games/SKILL.md +150 -0
- package/.agent/skills/geo-fundamentals/SKILL.md +156 -0
- package/.agent/skills/geo-fundamentals/scripts/geo_checker.py +289 -0
- package/.agent/skills/i18n-localization/SKILL.md +154 -0
- package/.agent/skills/i18n-localization/scripts/i18n_checker.py +241 -0
- package/.agent/skills/intelligent-routing/SKILL.md +335 -0
- package/.agent/skills/lint-and-validate/SKILL.md +45 -0
- package/.agent/skills/lint-and-validate/scripts/lint_runner.py +184 -0
- package/.agent/skills/lint-and-validate/scripts/type_coverage.py +173 -0
- package/.agent/skills/mcp-builder/SKILL.md +176 -0
- package/.agent/skills/mobile-design/SKILL.md +394 -0
- package/.agent/skills/mobile-design/decision-trees.md +516 -0
- package/.agent/skills/mobile-design/mobile-backend.md +491 -0
- package/.agent/skills/mobile-design/mobile-color-system.md +420 -0
- package/.agent/skills/mobile-design/mobile-debugging.md +122 -0
- package/.agent/skills/mobile-design/mobile-design-thinking.md +357 -0
- package/.agent/skills/mobile-design/mobile-navigation.md +458 -0
- package/.agent/skills/mobile-design/mobile-performance.md +767 -0
- package/.agent/skills/mobile-design/mobile-testing.md +356 -0
- package/.agent/skills/mobile-design/mobile-typography.md +433 -0
- package/.agent/skills/mobile-design/platform-android.md +666 -0
- package/.agent/skills/mobile-design/platform-ios.md +561 -0
- package/.agent/skills/mobile-design/scripts/mobile_audit.py +670 -0
- package/.agent/skills/mobile-design/touch-psychology.md +537 -0
- package/.agent/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +351 -0
- package/.agent/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -0
- package/.agent/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -0
- package/.agent/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -0
- package/.agent/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
- package/.agent/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -0
- package/.agent/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -0
- package/.agent/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -0
- package/.agent/skills/nextjs-react-expert/9-cache-components.md +103 -0
- package/.agent/skills/nextjs-react-expert/SKILL.md +293 -0
- package/.agent/skills/nextjs-react-expert/scripts/convert_rules.py +222 -0
- package/.agent/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
- package/.agent/skills/nodejs-best-practices/SKILL.md +333 -0
- package/.agent/skills/parallel-agents/SKILL.md +175 -0
- package/.agent/skills/performance-profiling/SKILL.md +143 -0
- package/.agent/skills/performance-profiling/scripts/lighthouse_audit.py +76 -0
- package/.agent/skills/plan-writing/SKILL.md +152 -0
- package/.agent/skills/powershell-windows/SKILL.md +167 -0
- package/.agent/skills/python-patterns/SKILL.md +441 -0
- package/.agent/skills/red-team-tactics/SKILL.md +388 -0
- package/.agent/skills/rust-pro/SKILL.md +176 -0
- package/.agent/skills/seo-fundamentals/SKILL.md +129 -0
- package/.agent/skills/seo-fundamentals/scripts/seo_checker.py +219 -0
- package/.agent/skills/server-management/SKILL.md +161 -0
- package/.agent/skills/systematic-debugging/SKILL.md +109 -0
- package/.agent/skills/tailwind-patterns/SKILL.md +269 -0
- package/.agent/skills/tdd-workflow/SKILL.md +149 -0
- package/.agent/skills/testing-patterns/SKILL.md +178 -0
- package/.agent/skills/testing-patterns/scripts/test_runner.py +219 -0
- package/.agent/skills/vulnerability-scanner/SKILL.md +276 -0
- package/.agent/skills/vulnerability-scanner/checklists.md +121 -0
- package/.agent/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/.agent/skills/web-design-guidelines/SKILL.md +57 -0
- package/.agent/skills/webapp-testing/SKILL.md +187 -0
- package/.agent/skills/webapp-testing/scripts/playwright_runner.py +173 -0
- package/.agent/workflows/brainstorm.md +113 -0
- package/.agent/workflows/create.md +59 -0
- package/.agent/workflows/cve-intel.md +84 -0
- package/.agent/workflows/debug.md +103 -0
- package/.agent/workflows/deploy.md +176 -0
- package/.agent/workflows/enhance.md +63 -0
- package/.agent/workflows/orchestrate.md +237 -0
- package/.agent/workflows/plan.md +89 -0
- package/.agent/workflows/preview.md +81 -0
- package/.agent/workflows/recon.md +116 -0
- package/.agent/workflows/scan.md +107 -0
- package/.agent/workflows/status.md +86 -0
- package/.agent/workflows/test.md +144 -0
- package/.agent/workflows/ui-ux-pro-max.md +296 -0
- package/LICENSE +21 -0
- package/README.md +146 -0
- package/bin/d1337-init.js +236 -0
- package/package.json +31 -0
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# Antigravity Skills
|
|
2
|
+
|
|
3
|
+
> **Guide to creating and using Skills in the Antigravity Kit**
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 📋 Overview
|
|
8
|
+
|
|
9
|
+
While Antigravity's base models (like Gemini) are powerful generalists, they don't know your specific project context or your team's standards. Loading every rule or tool into the agent's context window leads to "tool bloat," higher costs, latency, and confusion.
|
|
10
|
+
|
|
11
|
+
**Antigravity Skills** solve this through **Progressive Disclosure**. A Skill is a package of specialized knowledge that remains dormant until needed. This information is only loaded into the agent's context when your specific request matches the skill's description.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 📁 Structure and Scope
|
|
16
|
+
|
|
17
|
+
Skills are folder-based packages. You can define these scopes based on your needs:
|
|
18
|
+
|
|
19
|
+
| Scope | Path | Description |
|
|
20
|
+
| ------------- | --------------------------------- | ------------------------------------ |
|
|
21
|
+
| **Workspace** | `<workspace-root>/.agent/skills/` | Available only in a specific project |
|
|
22
|
+
|
|
23
|
+
### Skill Directory Structure
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
my-skill/
|
|
27
|
+
├── SKILL.md # (Required) Metadata & instructions
|
|
28
|
+
├── scripts/ # (Optional) Python or Bash scripts
|
|
29
|
+
├── references/ # (Optional) Text, documentation, templates
|
|
30
|
+
└── assets/ # (Optional) Images or logos
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 🔍 Example 1: Code Review Skill
|
|
36
|
+
|
|
37
|
+
This is an instruction-only skill; you only need to create the `SKILL.md` file.
|
|
38
|
+
|
|
39
|
+
### Step 1: Create the directory
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
mkdir -p .agent/skills/code-review
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Step 2: Create SKILL.md
|
|
46
|
+
|
|
47
|
+
```markdown
|
|
48
|
+
---
|
|
49
|
+
name: code-review
|
|
50
|
+
description: Reviews code changes for bugs, style issues, and best practices. Use when reviewing PRs or checking code quality.
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
# Code Review Skill
|
|
54
|
+
|
|
55
|
+
When reviewing code, follow these steps:
|
|
56
|
+
|
|
57
|
+
## Review checklist
|
|
58
|
+
|
|
59
|
+
1. **Correctness**: Does the code do what it's supposed to?
|
|
60
|
+
2. **Edge cases**: Are error conditions handled?
|
|
61
|
+
3. **Style**: Does it follow project conventions?
|
|
62
|
+
4. **Performance**: Are there obvious inefficiencies?
|
|
63
|
+
|
|
64
|
+
## How to provide feedback
|
|
65
|
+
|
|
66
|
+
- Be specific about what needs to change
|
|
67
|
+
- Explain why, not just what
|
|
68
|
+
- Suggest alternatives when possible
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
> **Note**: The `SKILL.md` file contains metadata (name, description) at the top, followed by the instructions. The agent will only read the metadata and load the full instructions only when needed.
|
|
72
|
+
|
|
73
|
+
### Try it out
|
|
74
|
+
|
|
75
|
+
Create a file `demo_bad_code.py`:
|
|
76
|
+
|
|
77
|
+
```python
|
|
78
|
+
import time
|
|
79
|
+
|
|
80
|
+
def get_user_data(users, id):
|
|
81
|
+
# Find user by ID
|
|
82
|
+
for u in users:
|
|
83
|
+
if u['id'] == id:
|
|
84
|
+
return u
|
|
85
|
+
return None
|
|
86
|
+
|
|
87
|
+
def process_payments(items):
|
|
88
|
+
total = 0
|
|
89
|
+
for i in items:
|
|
90
|
+
# Calculate tax
|
|
91
|
+
tax = i['price'] * 0.1
|
|
92
|
+
total = total + i['price'] + tax
|
|
93
|
+
time.sleep(0.1) # Simulate slow network call
|
|
94
|
+
return total
|
|
95
|
+
|
|
96
|
+
def run_batch():
|
|
97
|
+
users = [{'id': 1, 'name': 'Alice'}, {'id': 2, 'name': 'Bob'}]
|
|
98
|
+
items = [{'price': 10}, {'price': 20}, {'price': 100}]
|
|
99
|
+
|
|
100
|
+
u = get_user_data(users, 3)
|
|
101
|
+
print("User found: " + u['name']) # Will crash if None
|
|
102
|
+
|
|
103
|
+
print("Total: " + str(process_payments(items)))
|
|
104
|
+
|
|
105
|
+
if __name__ == "__main__":
|
|
106
|
+
run_batch()
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
**Prompt**: `review the @demo_bad_code.py file`
|
|
110
|
+
|
|
111
|
+
The Agent will automatically identify the `code-review` skill, load the information, and follow the instructions.
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## 📄 Example 2: License Header Skill
|
|
116
|
+
|
|
117
|
+
This skill uses a reference file in the `resources/` (or `references/`) directory.
|
|
118
|
+
|
|
119
|
+
### Step 1: Create the directory
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
mkdir -p .agent/skills/license-header-adder/resources
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Step 2: Create the template file
|
|
126
|
+
|
|
127
|
+
**`.agent/skills/license-header-adder/resources/HEADER.txt`**:
|
|
128
|
+
|
|
129
|
+
```
|
|
130
|
+
/*
|
|
131
|
+
* Copyright (c) 2026 YOUR_COMPANY_NAME LLC.
|
|
132
|
+
* All rights reserved.
|
|
133
|
+
* This code is proprietary and confidential.
|
|
134
|
+
*/
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Step 3: Create SKILL.md
|
|
138
|
+
|
|
139
|
+
**`.agent/skills/license-header-adder/SKILL.md`**:
|
|
140
|
+
|
|
141
|
+
```markdown
|
|
142
|
+
---
|
|
143
|
+
name: license-header-adder
|
|
144
|
+
description: Adds the standard corporate license header to new source files.
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
# License Header Adder
|
|
148
|
+
|
|
149
|
+
This skill ensures that all new source files have the correct copyright header.
|
|
150
|
+
|
|
151
|
+
## Instructions
|
|
152
|
+
|
|
153
|
+
1. **Read the Template**: Read the content of `resources/HEADER.txt`.
|
|
154
|
+
2. **Apply to File**: When creating a new file, prepend this exact content.
|
|
155
|
+
3. **Adapt Syntax**:
|
|
156
|
+
- For C-style languages (Java, TS), keep the `/* */` block.
|
|
157
|
+
- For Python/Shell, convert to `#` comments.
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Try it out
|
|
161
|
+
|
|
162
|
+
**Prompt**: `Create a new Python script named data_processor.py that prints 'Hello World'.`
|
|
163
|
+
|
|
164
|
+
The Agent will read the template, convert the comments to Python style, and automatically add it to the top of the file.
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
## 🎯 Conclusion
|
|
169
|
+
|
|
170
|
+
By creating Skills, you transform a general AI model into an expert for your project:
|
|
171
|
+
|
|
172
|
+
- ✅ Systematize best practices
|
|
173
|
+
- ✅ Adhere to code review rules
|
|
174
|
+
- ✅ Automatically add license headers
|
|
175
|
+
- ✅ The Agent automatically knows how to work with your team
|
|
176
|
+
|
|
177
|
+
Instead of constantly reminding the AI to "remember to add the license" or "fix the commit format," now the Agent will do it automatically!
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: documentation-templates
|
|
3
|
+
description: Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
|
|
4
|
+
allowed-tools: Read, Glob, Grep
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Documentation Templates
|
|
8
|
+
|
|
9
|
+
> Templates and structure guidelines for common documentation types.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 1. README Structure
|
|
14
|
+
|
|
15
|
+
### Essential Sections (Priority Order)
|
|
16
|
+
|
|
17
|
+
| Section | Purpose |
|
|
18
|
+
|---------|---------|
|
|
19
|
+
| **Title + One-liner** | What is this? |
|
|
20
|
+
| **Quick Start** | Running in <5 min |
|
|
21
|
+
| **Features** | What can I do? |
|
|
22
|
+
| **Configuration** | How to customize |
|
|
23
|
+
| **API Reference** | Link to detailed docs |
|
|
24
|
+
| **Contributing** | How to help |
|
|
25
|
+
| **License** | Legal |
|
|
26
|
+
|
|
27
|
+
### README Template
|
|
28
|
+
|
|
29
|
+
```markdown
|
|
30
|
+
# Project Name
|
|
31
|
+
|
|
32
|
+
Brief one-line description.
|
|
33
|
+
|
|
34
|
+
## Quick Start
|
|
35
|
+
|
|
36
|
+
[Minimum steps to run]
|
|
37
|
+
|
|
38
|
+
## Features
|
|
39
|
+
|
|
40
|
+
- Feature 1
|
|
41
|
+
- Feature 2
|
|
42
|
+
|
|
43
|
+
## Configuration
|
|
44
|
+
|
|
45
|
+
| Variable | Description | Default |
|
|
46
|
+
|----------|-------------|---------|
|
|
47
|
+
| PORT | Server port | 3000 |
|
|
48
|
+
|
|
49
|
+
## Documentation
|
|
50
|
+
|
|
51
|
+
- [API Reference](./docs/api.md)
|
|
52
|
+
- [Architecture](./docs/architecture.md)
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
MIT
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 2. API Documentation Structure
|
|
62
|
+
|
|
63
|
+
### Per-Endpoint Template
|
|
64
|
+
|
|
65
|
+
```markdown
|
|
66
|
+
## GET /users/:id
|
|
67
|
+
|
|
68
|
+
Get a user by ID.
|
|
69
|
+
|
|
70
|
+
**Parameters:**
|
|
71
|
+
| Name | Type | Required | Description |
|
|
72
|
+
|------|------|----------|-------------|
|
|
73
|
+
| id | string | Yes | User ID |
|
|
74
|
+
|
|
75
|
+
**Response:**
|
|
76
|
+
- 200: User object
|
|
77
|
+
- 404: User not found
|
|
78
|
+
|
|
79
|
+
**Example:**
|
|
80
|
+
[Request and response example]
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## 3. Code Comment Guidelines
|
|
86
|
+
|
|
87
|
+
### JSDoc/TSDoc Template
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
/**
|
|
91
|
+
* Brief description of what the function does.
|
|
92
|
+
*
|
|
93
|
+
* @param paramName - Description of parameter
|
|
94
|
+
* @returns Description of return value
|
|
95
|
+
* @throws ErrorType - When this error occurs
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* const result = functionName(input);
|
|
99
|
+
*/
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### When to Comment
|
|
103
|
+
|
|
104
|
+
| ✅ Comment | ❌ Don't Comment |
|
|
105
|
+
|-----------|-----------------|
|
|
106
|
+
| Why (business logic) | What (obvious) |
|
|
107
|
+
| Complex algorithms | Every line |
|
|
108
|
+
| Non-obvious behavior | Self-explanatory code |
|
|
109
|
+
| API contracts | Implementation details |
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## 4. Changelog Template (Keep a Changelog)
|
|
114
|
+
|
|
115
|
+
```markdown
|
|
116
|
+
# Changelog
|
|
117
|
+
|
|
118
|
+
## [Unreleased]
|
|
119
|
+
### Added
|
|
120
|
+
- New feature
|
|
121
|
+
|
|
122
|
+
## [1.0.0] - 2025-01-01
|
|
123
|
+
### Added
|
|
124
|
+
- Initial release
|
|
125
|
+
### Changed
|
|
126
|
+
- Updated dependency
|
|
127
|
+
### Fixed
|
|
128
|
+
- Bug fix
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## 5. Architecture Decision Record (ADR)
|
|
134
|
+
|
|
135
|
+
```markdown
|
|
136
|
+
# ADR-001: [Title]
|
|
137
|
+
|
|
138
|
+
## Status
|
|
139
|
+
Accepted / Deprecated / Superseded
|
|
140
|
+
|
|
141
|
+
## Context
|
|
142
|
+
Why are we making this decision?
|
|
143
|
+
|
|
144
|
+
## Decision
|
|
145
|
+
What did we decide?
|
|
146
|
+
|
|
147
|
+
## Consequences
|
|
148
|
+
What are the trade-offs?
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 6. AI-Friendly Documentation (2025)
|
|
154
|
+
|
|
155
|
+
### llms.txt Template
|
|
156
|
+
|
|
157
|
+
For AI crawlers and agents:
|
|
158
|
+
|
|
159
|
+
```markdown
|
|
160
|
+
# Project Name
|
|
161
|
+
> One-line objective.
|
|
162
|
+
|
|
163
|
+
## Core Files
|
|
164
|
+
- [src/index.ts]: Main entry
|
|
165
|
+
- [src/api/]: API routes
|
|
166
|
+
- [docs/]: Documentation
|
|
167
|
+
|
|
168
|
+
## Key Concepts
|
|
169
|
+
- Concept 1: Brief explanation
|
|
170
|
+
- Concept 2: Brief explanation
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### MCP-Ready Documentation
|
|
174
|
+
|
|
175
|
+
For RAG indexing:
|
|
176
|
+
- Clear H1-H3 hierarchy
|
|
177
|
+
- JSON/YAML examples for data structures
|
|
178
|
+
- Mermaid diagrams for flows
|
|
179
|
+
- Self-contained sections
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## 7. Structure Principles
|
|
184
|
+
|
|
185
|
+
| Principle | Why |
|
|
186
|
+
|-----------|-----|
|
|
187
|
+
| **Scannable** | Headers, lists, tables |
|
|
188
|
+
| **Examples first** | Show, don't just tell |
|
|
189
|
+
| **Progressive detail** | Simple → Complex |
|
|
190
|
+
| **Up to date** | Outdated = misleading |
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
> **Remember:** Templates are starting points. Adapt to your project's needs.
|