@zenrick/zenkit 0.0.0-stage → 0.5.1
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/.claude-plugin/marketplace.json +19 -0
- package/.cursor-plugin/marketplace.json +22 -0
- package/INSTALL.md +73 -0
- package/LICENSE +202 -0
- package/NOTICE +5 -0
- package/README.md +69 -3
- package/TERMS.md +48 -0
- package/THIRD-PARTY-NOTICES.md +109 -0
- package/kit/agents/backend-specialist.md +263 -0
- package/kit/agents/code-archaeologist.md +106 -0
- package/kit/agents/database-architect.md +226 -0
- package/kit/agents/debugger.md +226 -0
- package/kit/agents/devops-engineer.md +242 -0
- package/kit/agents/documentation-writer.md +104 -0
- package/kit/agents/explorer-agent.md +73 -0
- package/kit/agents/frontend-specialist.md +593 -0
- package/kit/agents/game-developer.md +162 -0
- package/kit/agents/mobile-developer.md +377 -0
- package/kit/agents/orchestrator.md +489 -0
- package/kit/agents/penetration-tester.md +188 -0
- package/kit/agents/performance-optimizer.md +187 -0
- package/kit/agents/product-manager.md +112 -0
- package/kit/agents/product-owner.md +95 -0
- package/kit/agents/project-planner.md +409 -0
- package/kit/agents/qa-automation-engineer.md +103 -0
- package/kit/agents/security-auditor.md +170 -0
- package/kit/agents/seo-specialist.md +111 -0
- package/kit/agents/test-engineer.md +158 -0
- package/kit/bundles/agent-building.yaml +26 -0
- package/kit/bundles/backend-data.yaml +14 -0
- package/kit/bundles/base.yaml +10 -0
- package/kit/bundles/core.yaml +21 -0
- package/kit/bundles/kit-engenharia.yaml +8 -0
- package/kit/bundles/kit-lite.yaml +9 -0
- package/kit/bundles/security.yaml +11 -0
- package/kit/bundles/ship-run.yaml +16 -0
- package/kit/bundles/web-ui.yaml +18 -0
- package/kit/commands/docs.md +33 -0
- package/kit/commands/explain.md +41 -0
- package/kit/commands/fix.md +65 -0
- package/kit/commands/implement.md +35 -0
- package/kit/commands/refactor.md +59 -0
- package/kit/commands/review.md +55 -0
- package/kit/commands/test.md +63 -0
- package/kit/modules/bridge/rules/cross-ide-bridge.mdc +73 -0
- package/kit/modules/bridge/zenkit-layer.yaml +1 -0
- package/kit/modules/nexuscore/sections/convivencia.md +12 -0
- package/kit/modules/nexuscore/sections/memoria.md +9 -0
- package/kit/modules/nexuscore/skills/quadro-agentes/SKILL.md +186 -0
- package/kit/modules/nexuscore/zenkit-layer.yaml +1 -0
- package/kit/rules/ZENKIT.mdc +294 -0
- package/kit/rules/git.mdc +51 -0
- package/kit/rules/karpathy-guidelines.mdc +70 -0
- package/kit/rules/model-routing.mdc +89 -0
- package/kit/rules/security-headers.mdc +41 -0
- package/kit/rules/social-automation.mdc +69 -0
- package/kit/rules/toc.mdc +40 -0
- package/kit/skills/api-patterns/SKILL.md +95 -0
- package/kit/skills/api-patterns/api-style.md +42 -0
- package/kit/skills/api-patterns/auth.md +24 -0
- package/kit/skills/api-patterns/documentation.md +26 -0
- package/kit/skills/api-patterns/graphql.md +41 -0
- package/kit/skills/api-patterns/rate-limiting.md +31 -0
- package/kit/skills/api-patterns/references/backend/backend-api-design.md +495 -0
- package/kit/skills/api-patterns/references/backend/backend-architecture.md +454 -0
- package/kit/skills/api-patterns/references/backend/backend-authentication.md +338 -0
- package/kit/skills/api-patterns/references/backend/backend-code-quality.md +659 -0
- package/kit/skills/api-patterns/references/backend/backend-debugging.md +904 -0
- package/kit/skills/api-patterns/references/backend/backend-devops.md +494 -0
- package/kit/skills/api-patterns/references/backend/backend-mindset.md +387 -0
- package/kit/skills/api-patterns/references/backend/backend-performance.md +397 -0
- package/kit/skills/api-patterns/references/backend/backend-security.md +290 -0
- package/kit/skills/api-patterns/references/backend/backend-technologies.md +256 -0
- package/kit/skills/api-patterns/references/backend/backend-testing.md +429 -0
- package/kit/skills/api-patterns/response.md +37 -0
- package/kit/skills/api-patterns/rest.md +40 -0
- package/kit/skills/api-patterns/scripts/api_validator.py +211 -0
- package/kit/skills/api-patterns/security-testing.md +122 -0
- package/kit/skills/api-patterns/trpc.md +41 -0
- package/kit/skills/api-patterns/versioning.md +22 -0
- package/kit/skills/app-builder/SKILL.md +76 -0
- package/kit/skills/app-builder/agent-coordination.md +71 -0
- package/kit/skills/app-builder/feature-building.md +53 -0
- package/kit/skills/app-builder/project-detection.md +34 -0
- package/kit/skills/app-builder/scaffolding.md +118 -0
- package/kit/skills/app-builder/tech-stack.md +41 -0
- package/kit/skills/app-builder/templates/SKILL.md +39 -0
- package/kit/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/kit/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/kit/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/kit/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/kit/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/kit/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/kit/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/kit/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -0
- package/kit/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -0
- package/kit/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -0
- package/kit/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -0
- package/kit/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/kit/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -0
- package/kit/skills/architecture/SKILL.md +56 -0
- package/kit/skills/architecture/context-discovery.md +43 -0
- package/kit/skills/architecture/examples.md +94 -0
- package/kit/skills/architecture/pattern-selection.md +68 -0
- package/kit/skills/architecture/patterns-reference.md +50 -0
- package/kit/skills/architecture/trade-off-analysis.md +77 -0
- package/kit/skills/bash-linux/SKILL.md +203 -0
- package/kit/skills/batch-operations/SKILL.md +112 -0
- package/kit/skills/behavioral-modes/SKILL.md +255 -0
- package/kit/skills/brainstorming/SKILL.md +189 -0
- package/kit/skills/brainstorming/dynamic-questioning.md +350 -0
- package/kit/skills/brainstorming/references/problem-solving/attribution.md +69 -0
- package/kit/skills/brainstorming/references/problem-solving/collision-zone-thinking.md +79 -0
- package/kit/skills/brainstorming/references/problem-solving/inversion-exercise.md +91 -0
- package/kit/skills/brainstorming/references/problem-solving/meta-pattern-recognition.md +87 -0
- package/kit/skills/brainstorming/references/problem-solving/scale-game.md +95 -0
- package/kit/skills/brainstorming/references/problem-solving/simplification-cascades.md +80 -0
- package/kit/skills/brainstorming/references/problem-solving/when-stuck.md +72 -0
- package/kit/skills/claude-exec/SKILL.md +185 -0
- package/kit/skills/clean-code/SKILL.md +210 -0
- package/kit/skills/code-review-checklist/SKILL.md +115 -0
- package/kit/skills/code-review-graph/SKILL.md +50 -0
- package/kit/skills/code-review-graph/references/alternatives-comparison.md +12 -0
- package/kit/skills/code-review-graph/references/best-practices.md +9 -0
- package/kit/skills/code-review-graph/references/configuration.md +43 -0
- package/kit/skills/code-review-graph/references/core-workflows.md +61 -0
- package/kit/skills/code-review-graph/references/how-it-works-4-layers.md +20 -0
- package/kit/skills/code-review-graph/references/installation.md +67 -0
- package/kit/skills/code-review-graph/references/integration-with-zenkit.md +23 -0
- package/kit/skills/code-review-graph/references/known-limitations.md +13 -0
- package/kit/skills/code-review-graph/references/when-to-use-vs-when-to-skip.md +21 -0
- package/kit/skills/codex-exec/SKILL.md +161 -0
- package/kit/skills/context-compression/SKILL.md +145 -0
- package/kit/skills/coordinator-mode/SKILL.md +215 -0
- package/kit/skills/cursor-exec/SKILL.md +152 -0
- package/kit/skills/database-design/SKILL.md +53 -0
- package/kit/skills/database-design/database-selection.md +43 -0
- package/kit/skills/database-design/indexing.md +39 -0
- package/kit/skills/database-design/migrations.md +48 -0
- package/kit/skills/database-design/optimization.md +36 -0
- package/kit/skills/database-design/orm-selection.md +30 -0
- package/kit/skills/database-design/schema-design.md +56 -0
- package/kit/skills/database-design/scripts/schema_validator.py +172 -0
- package/kit/skills/deployment-procedures/SKILL.md +242 -0
- package/kit/skills/deprecation-and-migration/SKILL.md +149 -0
- package/kit/skills/documentation-templates/SKILL.md +195 -0
- package/kit/skills/entrega-com-agentes/SKILL.md +177 -0
- package/kit/skills/frontend-design/NOTICE.md +6 -0
- package/kit/skills/frontend-design/SKILL.md +456 -0
- package/kit/skills/frontend-design/animation-guide.md +331 -0
- package/kit/skills/frontend-design/color-system.md +311 -0
- package/kit/skills/frontend-design/decision-trees.md +418 -0
- package/kit/skills/frontend-design/motion-graphics.md +306 -0
- package/kit/skills/frontend-design/references/aesthetic/design-guideline-template.md +163 -0
- package/kit/skills/frontend-design/references/aesthetic/design-principles.md +62 -0
- package/kit/skills/frontend-design/references/aesthetic/design-resources.md +75 -0
- package/kit/skills/frontend-design/references/aesthetic/design-story-template.md +135 -0
- package/kit/skills/frontend-design/references/aesthetic/micro-interactions.md +53 -0
- package/kit/skills/frontend-design/references/aesthetic/storytelling-design.md +50 -0
- package/kit/skills/frontend-design/scripts/accessibility_checker.py +183 -0
- package/kit/skills/frontend-design/scripts/ux_audit.py +722 -0
- package/kit/skills/frontend-design/typography-system.md +345 -0
- package/kit/skills/frontend-design/ux-psychology.md +1116 -0
- package/kit/skills/frontend-design/visual-effects.md +383 -0
- package/kit/skills/game-development/2d-games/SKILL.md +119 -0
- package/kit/skills/game-development/3d-games/SKILL.md +135 -0
- package/kit/skills/game-development/SKILL.md +168 -0
- package/kit/skills/game-development/game-art/SKILL.md +185 -0
- package/kit/skills/game-development/game-audio/SKILL.md +190 -0
- package/kit/skills/game-development/game-design/SKILL.md +129 -0
- package/kit/skills/game-development/mobile-games/SKILL.md +108 -0
- package/kit/skills/game-development/multiplayer/SKILL.md +132 -0
- package/kit/skills/game-development/pc-games/SKILL.md +144 -0
- package/kit/skills/game-development/vr-ar/SKILL.md +123 -0
- package/kit/skills/game-development/web-games/SKILL.md +150 -0
- package/kit/skills/gemini-exec/SKILL.md +80 -0
- package/kit/skills/geo-fundamentals/SKILL.md +157 -0
- package/kit/skills/geo-fundamentals/scripts/geo_checker.py +289 -0
- package/kit/skills/git-worktrees/SKILL.md +107 -0
- package/kit/skills/i18n-localization/SKILL.md +145 -0
- package/kit/skills/i18n-localization/scripts/i18n_checker.py +241 -0
- package/kit/skills/intelligent-routing/SKILL.md +128 -0
- package/kit/skills/intelligent-routing/references/4-response-format.md +16 -0
- package/kit/skills/intelligent-routing/references/complexity-assessment.md +29 -0
- package/kit/skills/intelligent-routing/references/debug-intelligent-routing.md +9 -0
- package/kit/skills/intelligent-routing/references/debugging-agent-selection.md +7 -0
- package/kit/skills/intelligent-routing/references/domain-detection-rules.md +29 -0
- package/kit/skills/intelligent-routing/references/edge-cases.md +29 -0
- package/kit/skills/intelligent-routing/references/implementation-rules.md +35 -0
- package/kit/skills/intelligent-routing/references/integration-with-existing-workflows.md +21 -0
- package/kit/skills/intelligent-routing/references/performance-considerations.md +14 -0
- package/kit/skills/intelligent-routing/references/summary.md +16 -0
- package/kit/skills/intelligent-routing/references/testing-the-system.md +36 -0
- package/kit/skills/intelligent-routing/references/tier-0-automatic-analysis-always-active.md +27 -0
- package/kit/skills/intelligent-routing/references/user-education.md +12 -0
- package/kit/skills/karpathy-guidelines/SKILL.md +67 -0
- package/kit/skills/karpathy-guidelines/references/EXAMPLES.md +522 -0
- package/kit/skills/lint-and-validate/SKILL.md +46 -0
- package/kit/skills/lint-and-validate/scripts/lint_runner.py +184 -0
- package/kit/skills/lint-and-validate/scripts/type_coverage.py +173 -0
- package/kit/skills/mcp-atuacao/SKILL.md +238 -0
- package/kit/skills/mcp-builder/NOTICE.md +6 -0
- package/kit/skills/mcp-builder/SKILL.md +259 -0
- package/kit/skills/memory-system/SKILL.md +181 -0
- package/kit/skills/mobile-design/SKILL.md +395 -0
- package/kit/skills/mobile-design/decision-trees.md +516 -0
- package/kit/skills/mobile-design/mobile-backend.md +491 -0
- package/kit/skills/mobile-design/mobile-color-system.md +420 -0
- package/kit/skills/mobile-design/mobile-debugging.md +122 -0
- package/kit/skills/mobile-design/mobile-design-thinking.md +357 -0
- package/kit/skills/mobile-design/mobile-navigation.md +458 -0
- package/kit/skills/mobile-design/mobile-performance.md +767 -0
- package/kit/skills/mobile-design/mobile-testing.md +356 -0
- package/kit/skills/mobile-design/mobile-typography.md +433 -0
- package/kit/skills/mobile-design/platform-android.md +666 -0
- package/kit/skills/mobile-design/platform-ios.md +561 -0
- package/kit/skills/mobile-design/scripts/mobile_audit.py +670 -0
- package/kit/skills/mobile-design/touch-psychology.md +537 -0
- package/kit/skills/negocio-agente-conversa/SKILL.md +168 -0
- package/kit/skills/negocio-atendimento/SKILL.md +134 -0
- package/kit/skills/negocio-linguagem/SKILL.md +166 -0
- package/kit/skills/negocio-preco/SKILL.md +174 -0
- package/kit/skills/negocio-preco/scripts/preco.mjs +160 -0
- package/kit/skills/negocio-qualificacao/SKILL.md +140 -0
- package/kit/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +351 -0
- package/kit/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -0
- package/kit/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -0
- package/kit/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -0
- package/kit/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
- package/kit/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -0
- package/kit/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -0
- package/kit/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -0
- package/kit/skills/nextjs-react-expert/9-cache-components.md +103 -0
- package/kit/skills/nextjs-react-expert/SKILL.md +308 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/common-patterns.md +331 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/complete-examples.md +872 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/component-patterns.md +502 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/data-fetching.md +767 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/file-organization.md +502 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/loading-and-error-states.md +501 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/performance.md +406 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/routing-guide.md +364 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/styling-guide.md +428 -0
- package/kit/skills/nextjs-react-expert/resources/app-patterns/typescript-standards.md +418 -0
- package/kit/skills/nextjs-react-expert/scripts/convert_rules.py +222 -0
- package/kit/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
- package/kit/skills/nodejs-best-practices/SKILL.md +78 -0
- package/kit/skills/nodejs-best-practices/references/10-anti-patterns-to-avoid.md +21 -0
- package/kit/skills/nodejs-best-practices/references/11-decision-checklist.md +14 -0
- package/kit/skills/nodejs-best-practices/references/2-runtime-considerations-2025.md +36 -0
- package/kit/skills/nodejs-best-practices/references/3-architecture-principles.md +35 -0
- package/kit/skills/nodejs-best-practices/references/4-error-handling-principles.md +42 -0
- package/kit/skills/nodejs-best-practices/references/5-async-patterns-principles.md +35 -0
- package/kit/skills/nodejs-best-practices/references/6-validation-principles.md +29 -0
- package/kit/skills/nodejs-best-practices/references/7-security-principles.md +29 -0
- package/kit/skills/nodejs-best-practices/references/8-testing-principles.md +28 -0
- package/kit/skills/observability-and-instrumentation/SKILL.md +150 -0
- package/kit/skills/opencode-go-exec/SKILL.md +101 -0
- package/kit/skills/parallel-agents/SKILL.md +184 -0
- package/kit/skills/performance-profiling/SKILL.md +145 -0
- package/kit/skills/performance-profiling/scripts/lighthouse_audit.py +76 -0
- package/kit/skills/plan-writing/SKILL.md +213 -0
- package/kit/skills/powershell-windows/SKILL.md +196 -0
- package/kit/skills/provider-orchestration/SKILL.md +269 -0
- package/kit/skills/python-patterns/SKILL.md +80 -0
- package/kit/skills/python-patterns/references/10-decision-checklist.md +14 -0
- package/kit/skills/python-patterns/references/11-anti-patterns-to-avoid.md +20 -0
- package/kit/skills/python-patterns/references/2-async-vs-sync-decision.md +44 -0
- package/kit/skills/python-patterns/references/3-type-hints-strategy.md +56 -0
- package/kit/skills/python-patterns/references/4-project-structure-principles.md +56 -0
- package/kit/skills/python-patterns/references/5-django-principles-2025.md +40 -0
- package/kit/skills/python-patterns/references/6-fastapi-principles.md +50 -0
- package/kit/skills/python-patterns/references/7-background-tasks.md +31 -0
- package/kit/skills/python-patterns/references/8-error-handling-principles.md +29 -0
- package/kit/skills/python-patterns/references/9-testing-principles.md +37 -0
- package/kit/skills/red-team-tactics/SKILL.md +201 -0
- package/kit/skills/research/SKILL.md +166 -0
- package/kit/skills/rust-pro/SKILL.md +177 -0
- package/kit/skills/seo-fundamentals/SKILL.md +130 -0
- package/kit/skills/seo-fundamentals/scripts/seo_checker.py +219 -0
- package/kit/skills/sequential-thinking/.env.example +8 -0
- package/kit/skills/sequential-thinking/README.md +183 -0
- package/kit/skills/sequential-thinking/SKILL.md +95 -0
- package/kit/skills/sequential-thinking/package.json +31 -0
- package/kit/skills/sequential-thinking/references/advanced-strategies.md +79 -0
- package/kit/skills/sequential-thinking/references/advanced-techniques.md +76 -0
- package/kit/skills/sequential-thinking/references/core-patterns.md +95 -0
- package/kit/skills/sequential-thinking/references/examples-api.md +88 -0
- package/kit/skills/sequential-thinking/references/examples-architecture.md +94 -0
- package/kit/skills/sequential-thinking/references/examples-debug.md +90 -0
- package/kit/skills/sequential-thinking/scripts/format-thought.js +159 -0
- package/kit/skills/sequential-thinking/scripts/process-thought.js +236 -0
- package/kit/skills/server-management/SKILL.md +162 -0
- package/kit/skills/simplify-code/SKILL.md +133 -0
- package/kit/skills/skillify/SKILL.md +116 -0
- package/kit/skills/system-design-interview/SKILL.md +268 -0
- package/kit/skills/systematic-debugging/SKILL.md +110 -0
- package/kit/skills/tailwind-patterns/SKILL.md +283 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/canvas-design-system.md +320 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/shadcn-accessibility.md +471 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/shadcn-components.md +424 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/shadcn-theming.md +373 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/tailwind-customization.md +483 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/tailwind-responsive.md +382 -0
- package/kit/skills/tailwind-patterns/references/shadcn-ui/tailwind-utilities.md +455 -0
- package/kit/skills/tdd-workflow/SKILL.md +150 -0
- package/kit/skills/testing-patterns/SKILL.md +196 -0
- package/kit/skills/testing-patterns/scripts/test_runner.py +219 -0
- package/kit/skills/ui-ux-pro-max/SKILL.md +135 -0
- package/kit/skills/verify-changes/SKILL.md +125 -0
- package/kit/skills/vulnerability-scanner/SKILL.md +278 -0
- package/kit/skills/vulnerability-scanner/checklists.md +121 -0
- package/kit/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/kit/skills/web-design-guidelines/SKILL.md +58 -0
- package/kit/skills/webapp-testing/NOTICE.md +6 -0
- package/kit/skills/webapp-testing/SKILL.md +188 -0
- package/kit/skills/webapp-testing/scripts/playwright_runner.py +173 -0
- package/kit/workflows/brainstorm.md +113 -0
- package/kit/workflows/coordinate.md +72 -0
- package/kit/workflows/create.md +59 -0
- package/kit/workflows/debug.md +103 -0
- package/kit/workflows/deploy.md +176 -0
- package/kit/workflows/enhance.md +63 -0
- package/kit/workflows/orchestrate.md +237 -0
- package/kit/workflows/plan.md +89 -0
- package/kit/workflows/preview.md +81 -0
- package/kit/workflows/remember.md +67 -0
- package/kit/workflows/status.md +86 -0
- package/kit/workflows/test.md +144 -0
- package/kit/workflows/ui-ux-pro-max.md +296 -0
- package/kit/workflows/verify.md +72 -0
- package/licenses/Apache-2.0.txt +202 -0
- package/package.json +60 -6
- package/scripts/archive-codex-rollouts.ps1 +35 -0
- package/scripts/avaliar-vigilancia-mandato.mjs +38 -0
- package/scripts/bundle.mjs +170 -0
- package/scripts/check-deps.mjs +178 -0
- package/scripts/check-models.mjs +150 -0
- package/scripts/cli.mjs +313 -0
- package/scripts/content-checks.mjs +18 -0
- package/scripts/continuidade-mandato.mjs +47 -0
- package/scripts/discriminar-turno.mjs +191 -0
- package/scripts/doctor.mjs +611 -0
- package/scripts/generate.mjs +688 -0
- package/scripts/install.mjs +11 -0
- package/scripts/layer-remote.mjs +407 -0
- package/scripts/layers.mjs +208 -0
- package/scripts/marketplace.mjs +77 -0
- package/scripts/product.mjs +32 -0
- package/scripts/ruleset-core.mjs +68 -0
- package/scripts/social-hooks.mjs +293 -0
- package/scripts/social-pacer.mjs +219 -0
- package/scripts/validate-bundles.mjs +14 -0
- package/scripts/validate-skills.mjs +174 -0
- package/scripts/zenkit-daemon-task.cmd +3 -0
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: deployment-procedures
|
|
3
|
+
description: Production deployment principles and decision-making. Safe deployment workflows, rollback strategies, and verification. Teaches thinking, not scripts.
|
|
4
|
+
when_to_use: "When deploying to production, planning rollback strategies, or setting up CI/CD pipelines. Use with /deploy workflow."
|
|
5
|
+
allowed-tools: Read, Glob, Grep, Bash
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Deployment Procedures
|
|
9
|
+
|
|
10
|
+
> Deployment principles and decision-making for safe production releases.
|
|
11
|
+
> **Learn to THINK, not memorize scripts.**
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## ⚠️ How to Use This Skill
|
|
16
|
+
|
|
17
|
+
This skill teaches **deployment principles**, not bash scripts to copy.
|
|
18
|
+
|
|
19
|
+
- Every deployment is unique
|
|
20
|
+
- Understand the WHY behind each step
|
|
21
|
+
- Adapt procedures to your platform
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 1. Platform Selection
|
|
26
|
+
|
|
27
|
+
### Decision Tree
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
What are you deploying?
|
|
31
|
+
│
|
|
32
|
+
├── Static site / JAMstack
|
|
33
|
+
│ └── Vercel, Netlify, Cloudflare Pages
|
|
34
|
+
│
|
|
35
|
+
├── Simple web app
|
|
36
|
+
│ ├── Managed → Railway, Render, Fly.io
|
|
37
|
+
│ └── Control → VPS + PM2/Docker
|
|
38
|
+
│
|
|
39
|
+
├── Microservices
|
|
40
|
+
│ └── Container orchestration
|
|
41
|
+
│
|
|
42
|
+
└── Serverless
|
|
43
|
+
└── Edge functions, Lambda
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Each Platform Has Different Procedures
|
|
47
|
+
|
|
48
|
+
| Platform | Deployment Method |
|
|
49
|
+
|----------|------------------|
|
|
50
|
+
| **Vercel/Netlify** | Git push, auto-deploy |
|
|
51
|
+
| **Railway/Render** | Git push or CLI |
|
|
52
|
+
| **VPS / Dokploy / Coolify** | Automated Git webhook / CI pipeline |
|
|
53
|
+
| **Docker** | Immutable digest push (`sha256`) + compose update |
|
|
54
|
+
| **Kubernetes** | GitOps / kubectl apply with immutable image digest |
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## 2. Pre-Deployment Principles
|
|
59
|
+
|
|
60
|
+
### The 4 Verification Categories
|
|
61
|
+
|
|
62
|
+
| Category | What to Check |
|
|
63
|
+
|----------|--------------|
|
|
64
|
+
| **Code Quality** | Tests passing, linting clean, reviewed |
|
|
65
|
+
| **Build** | Production build works, no warnings |
|
|
66
|
+
| **Environment** | Env vars verified, secrets managed via central manager |
|
|
67
|
+
| **Safety** | Additive schema compatibility, immutable rollback artifact verified |
|
|
68
|
+
|
|
69
|
+
### Pre-Deployment Checklist
|
|
70
|
+
|
|
71
|
+
- [ ] All tests passing
|
|
72
|
+
- [ ] Code reviewed and approved
|
|
73
|
+
- [ ] Production build successful
|
|
74
|
+
- [ ] Environment variables verified
|
|
75
|
+
- [ ] Database migrations backward-compatible (expand phase)
|
|
76
|
+
- [ ] Rollback artifact and procedure ready
|
|
77
|
+
- [ ] Team notified
|
|
78
|
+
- [ ] Monitoring ready
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## 3. Deployment Workflow Principles
|
|
83
|
+
|
|
84
|
+
### The 5-Phase Process
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
1. PREPARE
|
|
88
|
+
└── Verify code, build, env vars
|
|
89
|
+
|
|
90
|
+
2. SAFEGUARD
|
|
91
|
+
└── Verify backward compatibility (expand/contract) and rollback targets
|
|
92
|
+
|
|
93
|
+
3. DEPLOY
|
|
94
|
+
└── Execute rolling/canary deploy with monitoring open
|
|
95
|
+
|
|
96
|
+
4. VERIFY
|
|
97
|
+
└── Liveness & readiness probes, error logs, critical user flows
|
|
98
|
+
|
|
99
|
+
5. CONFIRM or ROLLBACK
|
|
100
|
+
└── All good? Confirm. Issues? Fast traffic rollback to prior immutable digest.
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Phase Principles
|
|
104
|
+
|
|
105
|
+
| Phase | Principle |
|
|
106
|
+
|-------|-----------|
|
|
107
|
+
| **Prepare** | Never deploy untested code |
|
|
108
|
+
| **Safeguard** | Schema changes must be backward-compatible before traffic shifts |
|
|
109
|
+
| **Deploy** | Watch it happen with liveness and readiness monitoring |
|
|
110
|
+
| **Verify** | Trust but verify key business flows |
|
|
111
|
+
| **Confirm** | Automated rollback trigger ready if health checks or error budgets fail |
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## 4. Post-Deployment Verification
|
|
116
|
+
|
|
117
|
+
### What to Verify
|
|
118
|
+
|
|
119
|
+
| Check | Why |
|
|
120
|
+
|-------|-----|
|
|
121
|
+
| **Health endpoint** | Service is running |
|
|
122
|
+
| **Error logs** | No new errors |
|
|
123
|
+
| **Key user flows** | Critical features work |
|
|
124
|
+
| **Performance** | Response times acceptable |
|
|
125
|
+
|
|
126
|
+
### Verification Window
|
|
127
|
+
|
|
128
|
+
- **First 5 minutes**: Active monitoring
|
|
129
|
+
- **15 minutes**: Confirm stable
|
|
130
|
+
- **1 hour**: Final verification
|
|
131
|
+
- **Next day**: Review metrics
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## 5. Rollback Principles
|
|
136
|
+
|
|
137
|
+
### When to Rollback
|
|
138
|
+
|
|
139
|
+
| Symptom | Action |
|
|
140
|
+
|---------|--------|
|
|
141
|
+
| Service down | Rollback immediately |
|
|
142
|
+
| Critical errors | Rollback |
|
|
143
|
+
| Performance >50% degraded | Consider rollback |
|
|
144
|
+
| Minor issues | Fix forward if quick |
|
|
145
|
+
|
|
146
|
+
### Rollback Strategy by Platform
|
|
147
|
+
|
|
148
|
+
| Platform | Rollback Method |
|
|
149
|
+
|----------|----------------|
|
|
150
|
+
| **Vercel/Netlify** | Instant rollback to previous deployment target |
|
|
151
|
+
| **Railway/Render** | Rollback to previous deployment |
|
|
152
|
+
| **VPS / Dokploy / Coolify** | Switch traffic / container to previous commit SHA |
|
|
153
|
+
| **Docker** | Rollback to previous verified immutable image digest (`sha256:...`) |
|
|
154
|
+
| **K8s** | `kubectl rollout undo` with healthcheck gates |
|
|
155
|
+
|
|
156
|
+
### Rollback Principles
|
|
157
|
+
|
|
158
|
+
1. **Speed over perfection**: Rollback first, debug later
|
|
159
|
+
2. **Don't compound errors**: One rollback, not multiple changes
|
|
160
|
+
3. **Communicate**: Tell team what happened
|
|
161
|
+
4. **Post-mortem**: Understand why after stable
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## 6. Zero-Downtime Deployment
|
|
166
|
+
|
|
167
|
+
### Strategies
|
|
168
|
+
|
|
169
|
+
| Strategy | How It Works |
|
|
170
|
+
|----------|--------------|
|
|
171
|
+
| **Rolling** | Replace instances one by one |
|
|
172
|
+
| **Blue-Green** | Switch traffic between environments |
|
|
173
|
+
| **Canary** | Gradual traffic shift |
|
|
174
|
+
|
|
175
|
+
### Selection Principles
|
|
176
|
+
|
|
177
|
+
| Scenario | Strategy |
|
|
178
|
+
|----------|----------|
|
|
179
|
+
| Standard release | Rolling |
|
|
180
|
+
| High-risk change | Blue-green (easy rollback) |
|
|
181
|
+
| Need validation | Canary (test with real traffic) |
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## 7. Emergency Procedures
|
|
186
|
+
|
|
187
|
+
### Service Down Priority
|
|
188
|
+
|
|
189
|
+
1. **Assess**: What's the symptom?
|
|
190
|
+
2. **Quick fix**: Restart if unclear
|
|
191
|
+
3. **Rollback**: If restart doesn't help
|
|
192
|
+
4. **Investigate**: After stable
|
|
193
|
+
|
|
194
|
+
### Investigation Order
|
|
195
|
+
|
|
196
|
+
| Check | Common Issues |
|
|
197
|
+
|-------|--------------|
|
|
198
|
+
| **Logs** | Errors, exceptions |
|
|
199
|
+
| **Resources** | Disk full, memory |
|
|
200
|
+
| **Network** | DNS, firewall |
|
|
201
|
+
| **Dependencies** | Database, APIs |
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
## 8. Anti-Patterns
|
|
206
|
+
|
|
207
|
+
| ❌ Don't | ✅ Do |
|
|
208
|
+
|----------|-------|
|
|
209
|
+
| Deploy on Friday | Deploy early in week |
|
|
210
|
+
| Rush deployment | Follow the process |
|
|
211
|
+
| Skip staging | Always test first |
|
|
212
|
+
| Deploy without backup | Backup before deploy |
|
|
213
|
+
| Walk away after deploy | Monitor for 15+ min |
|
|
214
|
+
| Multiple changes at once | One change at a time |
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
## 9. Decision Checklist
|
|
219
|
+
|
|
220
|
+
Before deploying:
|
|
221
|
+
|
|
222
|
+
- [ ] **Platform-appropriate procedure?**
|
|
223
|
+
- [ ] **Backup strategy ready?**
|
|
224
|
+
- [ ] **Rollback plan documented?**
|
|
225
|
+
- [ ] **Monitoring configured?**
|
|
226
|
+
- [ ] **Team notified?**
|
|
227
|
+
- [ ] **Time to monitor after?**
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## 10. Best Practices
|
|
232
|
+
|
|
233
|
+
1. **Small, frequent deploys** over big releases
|
|
234
|
+
2. **Feature flags** for risky changes
|
|
235
|
+
3. **Automate** repetitive steps
|
|
236
|
+
4. **Document** every deployment
|
|
237
|
+
5. **Review** what went wrong after issues
|
|
238
|
+
6. **Test rollback** before you need it
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
|
|
242
|
+
> **Remember:** Every deployment is a risk. Minimize risk through preparation, not speed.
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: deprecation-and-migration
|
|
3
|
+
description: Retire APIs, fields, flags, and services without breaking consumers — through usage discovery, expand-migrate-contract phases, and time-boxed removal.
|
|
4
|
+
when_to_use: "When deprecating an endpoint, field, feature flag, library, table, or service. When the user says 'remove this API', 'migrate users to v2', 'sunset this feature', 'delete this column', or 'how do we deprecate safely?'. NOT for greenfield design — for retiring what already exists."
|
|
5
|
+
allowed-tools: Read, Glob, Grep
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Deprecation and Migration
|
|
9
|
+
|
|
10
|
+
> Removing something without knowing who still uses it is not a migration — it is an outage scheduled for your next deploy.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 1. Discover Who Uses It Before You Remove It
|
|
15
|
+
|
|
16
|
+
Code search finds internal callers. It does **not** find external consumers, mobile apps on old versions, or partners hitting undocumented endpoints.
|
|
17
|
+
|
|
18
|
+
| Discovery method | Finds |
|
|
19
|
+
|---|---|
|
|
20
|
+
| `grep` / static analysis | In-repo references |
|
|
21
|
+
| Usage telemetry (request counts per endpoint/field) | Real consumers, including external |
|
|
22
|
+
| Access logs with versioning | Clients you did not know existed |
|
|
23
|
+
| Support tickets / partner comms | Business-critical dependencies |
|
|
24
|
+
|
|
25
|
+
**Telemetry answers "who still uses this?"** Code search only answers "who do we think uses this?"
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## 2. Expand → Migrate → Contract
|
|
30
|
+
|
|
31
|
+
Never do all three in one deploy. Each phase is a separate release with its own rollback story.
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
Phase 1 — EXPAND: Add the new thing alongside the old (both work)
|
|
35
|
+
Phase 2 — MIGRATE: Move consumers to the new thing (old still works)
|
|
36
|
+
Phase 3 — CONTRACT: Remove the old thing (only after usage = 0)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
| Anti-pattern | Result |
|
|
40
|
+
|---|---|
|
|
41
|
+
| Add new API and delete old in same PR | Rollback breaks everyone |
|
|
42
|
+
| Skip expand, force-migrate in one shot | Downtime for stragglers |
|
|
43
|
+
| Contract before usage hits zero | Silent breakage for unknown clients |
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 3. Both Sides Must Coexist During Migration (Parallel Change)
|
|
48
|
+
|
|
49
|
+
During migration, **new code must read old data** and **old code must read new data** (or tolerate absence). Establish a clear primary source of truth (single source of truth) or asynchronous CDC/triggers to avoid split-brain race conditions.
|
|
50
|
+
|
|
51
|
+
| Pattern | When |
|
|
52
|
+
|---|---|
|
|
53
|
+
| Primary write + async sync | Write to primary store; sync to new store via CDC/events |
|
|
54
|
+
| Backward-compatible reads | New code handles old schema; old code ignores new fields (Tolerant Reader) |
|
|
55
|
+
| Shadow reads | New path reads new store, compares with old, logs diffs |
|
|
56
|
+
|
|
57
|
+
If only one direction works, you have a flag day — not a migration.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 4. Deprecation Is an Announcement With a Date (RFC 8594)
|
|
62
|
+
|
|
63
|
+
A `@deprecated` comment in source code is invisible to consumers. Real deprecation includes:
|
|
64
|
+
|
|
65
|
+
| Element | Example |
|
|
66
|
+
|---|---|
|
|
67
|
+
| **Deadline (RFC 8594)** | `Sunset: Tue, 01 Sep 2026 00:00:00 GMT` |
|
|
68
|
+
| **Alternative** | `Use POST /v2/orders instead` |
|
|
69
|
+
| **Migration guide** | Link to docs with before/after examples |
|
|
70
|
+
| **Communication** | Changelog, email, response header (`Deprecation: @1756684800` / `Link: <...>; rel="sunset"`) |
|
|
71
|
+
|
|
72
|
+
Without a deadline, "deprecated" means "we feel bad about this but will never remove it."
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## 5. Data Migration Must Be Idempotent and Backward-Compatible
|
|
77
|
+
|
|
78
|
+
A migration script that cannot be re-run will fail halfway and leave corrupt state. Under Expand/Contract, schema changes must be strictly additive so code rollbacks do not require destructive DDL downgrades.
|
|
79
|
+
|
|
80
|
+
| Requirement | Why |
|
|
81
|
+
|---|---|
|
|
82
|
+
| **Idempotent** | Re-run after partial failure without duplicating data |
|
|
83
|
+
| **Additive Schema** | New columns nullable/defaulted so previous code version runs safely |
|
|
84
|
+
| **Tested on copy** | Production data shape surprises you |
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
❌ Deploy code v2, run destructive DDL, hope rollback works
|
|
88
|
+
✅ Additive schema deployed first (expand); backfill runs; old & new code coexist; cleanup later (contract)
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## 6. Migrate in Batches With Counts
|
|
94
|
+
|
|
95
|
+
A migration without a number has no end.
|
|
96
|
+
|
|
97
|
+
```markdown
|
|
98
|
+
## Migration Progress
|
|
99
|
+
- Total records: 1,200,000
|
|
100
|
+
- Migrated: 840,000 (70%)
|
|
101
|
+
- Remaining: 360,000
|
|
102
|
+
- Failed (retry queue): 142
|
|
103
|
+
- ETA at current rate: 3 days
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Batch by primary key or cursor. Log progress. Alert on stall. **You cannot contract until remaining = 0.**
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## 7. Remove the Old Thing For Real
|
|
111
|
+
|
|
112
|
+
"Temporary" compatibility shims become permanent tax. If you will not remove it, it was never a deprecation — it was duplication.
|
|
113
|
+
|
|
114
|
+
| Shim type | Risk of keeping forever |
|
|
115
|
+
|---|---|
|
|
116
|
+
| Adapter translating v1 → v2 | Two codepaths, double bugs |
|
|
117
|
+
| DB column "kept for safety" | Confusing writes, stale reads |
|
|
118
|
+
| Proxy routing old URL to new | Hidden consumers never migrate |
|
|
119
|
+
|
|
120
|
+
Set a removal date. Execute it. Delete the code.
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## 8. Feature Flags Have a Death Date
|
|
125
|
+
|
|
126
|
+
A flag that survives the migration becomes a **dead branch** nobody knows is safe to delete.
|
|
127
|
+
|
|
128
|
+
| Flag lifecycle | Action |
|
|
129
|
+
|---|---|
|
|
130
|
+
| Created for migration | Document owner and removal date |
|
|
131
|
+
| Migration complete | Delete flag and both code paths in same PR |
|
|
132
|
+
| Flag older than 90 days post-migration | Smell — audit and remove |
|
|
133
|
+
|
|
134
|
+
```
|
|
135
|
+
❌ if (featureFlags.useNewCheckout) { ... } else { ... } // 18 months later, both paths untested
|
|
136
|
+
✅ Flag removed; single path; tests cover it
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
|
|
141
|
+
## Anti-Patterns
|
|
142
|
+
|
|
143
|
+
| Anti-pattern | Why it fails | Fix |
|
|
144
|
+
|---|---|---|
|
|
145
|
+
| Remove endpoint, grep says clean | External clients still call it | Telemetry-first discovery |
|
|
146
|
+
| Big-bang migration in one deploy | No rollback | Expand → migrate → contract |
|
|
147
|
+
| `@deprecated` with no date | Never removed | Announcement + deadline + comms |
|
|
148
|
+
| Migration script run once, no idempotency | Partial failure corrupts data | Idempotent batches with counts |
|
|
149
|
+
| Feature flag lives forever | Dead code, untested branch | Flag death date in ticket |
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: documentation-templates
|
|
3
|
+
description: Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
|
|
4
|
+
when_to_use: "When writing README files, API documentation, code comments, or generating AI-friendly documentation."
|
|
5
|
+
allowed-tools: Read, Glob, Grep
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Documentation Templates
|
|
9
|
+
|
|
10
|
+
> Templates and structure guidelines for common documentation types.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 1. README Structure
|
|
15
|
+
|
|
16
|
+
### Essential Sections (Priority Order)
|
|
17
|
+
|
|
18
|
+
| Section | Purpose |
|
|
19
|
+
|---------|---------|
|
|
20
|
+
| **Title + One-liner** | What is this? |
|
|
21
|
+
| **Quick Start** | Running in <5 min |
|
|
22
|
+
| **Features** | What can I do? |
|
|
23
|
+
| **Configuration** | How to customize |
|
|
24
|
+
| **API Reference** | Link to detailed docs |
|
|
25
|
+
| **Contributing** | How to help |
|
|
26
|
+
| **License** | Legal |
|
|
27
|
+
|
|
28
|
+
### README Template
|
|
29
|
+
|
|
30
|
+
```markdown
|
|
31
|
+
# Project Name
|
|
32
|
+
|
|
33
|
+
Brief one-line description.
|
|
34
|
+
|
|
35
|
+
## Quick Start
|
|
36
|
+
|
|
37
|
+
[Minimum steps to run]
|
|
38
|
+
|
|
39
|
+
## Features
|
|
40
|
+
|
|
41
|
+
- Feature 1
|
|
42
|
+
- Feature 2
|
|
43
|
+
|
|
44
|
+
## Configuration
|
|
45
|
+
|
|
46
|
+
| Variable | Description | Default |
|
|
47
|
+
|----------|-------------|---------|
|
|
48
|
+
| PORT | Server port | 3000 |
|
|
49
|
+
|
|
50
|
+
## Documentation
|
|
51
|
+
|
|
52
|
+
- [API Reference](./docs/api.md)
|
|
53
|
+
- [Architecture](./docs/architecture.md)
|
|
54
|
+
|
|
55
|
+
## License
|
|
56
|
+
|
|
57
|
+
MIT
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## 2. API Documentation Structure
|
|
63
|
+
|
|
64
|
+
### Per-Endpoint Template
|
|
65
|
+
|
|
66
|
+
```markdown
|
|
67
|
+
## GET /users/:id
|
|
68
|
+
|
|
69
|
+
Get a user by ID.
|
|
70
|
+
|
|
71
|
+
**Parameters:**
|
|
72
|
+
| Name | Type | Required | Description |
|
|
73
|
+
|------|------|----------|-------------|
|
|
74
|
+
| id | string | Yes | User ID |
|
|
75
|
+
|
|
76
|
+
**Response:**
|
|
77
|
+
- 200: User object
|
|
78
|
+
- 404: User not found
|
|
79
|
+
|
|
80
|
+
**Example:**
|
|
81
|
+
[Request and response example]
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## 3. Code Comment Guidelines
|
|
87
|
+
|
|
88
|
+
### JSDoc/TSDoc Template
|
|
89
|
+
|
|
90
|
+
```typescript
|
|
91
|
+
/**
|
|
92
|
+
* Brief description of what the function does.
|
|
93
|
+
*
|
|
94
|
+
* @param paramName - Description of parameter
|
|
95
|
+
* @returns Description of return value
|
|
96
|
+
* @throws ErrorType - When this error occurs
|
|
97
|
+
*
|
|
98
|
+
* @example
|
|
99
|
+
* const result = functionName(input);
|
|
100
|
+
*/
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### When to Comment
|
|
104
|
+
|
|
105
|
+
| ✅ Comment | ❌ Don't Comment |
|
|
106
|
+
|-----------|-----------------|
|
|
107
|
+
| Why (business logic) | What (obvious) |
|
|
108
|
+
| Complex algorithms | Every line |
|
|
109
|
+
| Non-obvious behavior | Self-explanatory code |
|
|
110
|
+
| API contracts | Implementation details |
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## 4. Changelog Template (Keep a Changelog)
|
|
115
|
+
|
|
116
|
+
```markdown
|
|
117
|
+
# Changelog
|
|
118
|
+
|
|
119
|
+
## [Unreleased]
|
|
120
|
+
### Added
|
|
121
|
+
- New feature
|
|
122
|
+
|
|
123
|
+
## [1.0.0] - 2025-01-01
|
|
124
|
+
### Added
|
|
125
|
+
- Initial release
|
|
126
|
+
### Changed
|
|
127
|
+
- Updated dependency
|
|
128
|
+
### Fixed
|
|
129
|
+
- Bug fix
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## 5. Architecture Decision Record (ADR)
|
|
135
|
+
|
|
136
|
+
```markdown
|
|
137
|
+
# ADR-001: [Title]
|
|
138
|
+
|
|
139
|
+
## Status
|
|
140
|
+
Accepted / Deprecated / Superseded
|
|
141
|
+
|
|
142
|
+
## Context
|
|
143
|
+
Why are we making this decision?
|
|
144
|
+
|
|
145
|
+
## Decision
|
|
146
|
+
What did we decide?
|
|
147
|
+
|
|
148
|
+
## Consequences
|
|
149
|
+
What are the trade-offs?
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
## 6. AI-Friendly Documentation (2025)
|
|
155
|
+
|
|
156
|
+
### llms.txt Template
|
|
157
|
+
|
|
158
|
+
For AI crawlers and agents:
|
|
159
|
+
|
|
160
|
+
```markdown
|
|
161
|
+
# Project Name
|
|
162
|
+
> One-line objective.
|
|
163
|
+
|
|
164
|
+
## Core Files
|
|
165
|
+
- [src/index.ts]: Main entry
|
|
166
|
+
- [src/api/]: API routes
|
|
167
|
+
- [docs/]: Documentation
|
|
168
|
+
|
|
169
|
+
## Key Concepts
|
|
170
|
+
- Concept 1: Brief explanation
|
|
171
|
+
- Concept 2: Brief explanation
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### MCP-Ready Documentation
|
|
175
|
+
|
|
176
|
+
For RAG indexing:
|
|
177
|
+
- Clear H1-H3 hierarchy
|
|
178
|
+
- JSON/YAML examples for data structures
|
|
179
|
+
- Mermaid diagrams for flows
|
|
180
|
+
- Self-contained sections
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## 7. Structure Principles
|
|
185
|
+
|
|
186
|
+
| Principle | Why |
|
|
187
|
+
|-----------|-----|
|
|
188
|
+
| **Scannable** | Headers, lists, tables |
|
|
189
|
+
| **Examples first** | Show, don't just tell |
|
|
190
|
+
| **Progressive detail** | Simple → Complex |
|
|
191
|
+
| **Up to date** | Outdated = misleading |
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
> **Remember:** Templates are starting points. Adapt to your project's needs.
|