flyee 0.1.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/LICENSE +21 -0
- package/README.md +134 -0
- package/bin/install.js +357 -0
- package/bridge/bridge.py +1780 -0
- package/bridge/local_tracker.py +722 -0
- package/core/agents/backend-specialist.md +266 -0
- package/core/agents/code-archaeologist.md +106 -0
- package/core/agents/database-architect.md +226 -0
- package/core/agents/debugger.md +225 -0
- package/core/agents/devops-engineer.md +323 -0
- package/core/agents/documentation-writer.md +104 -0
- package/core/agents/explorer-agent.md +73 -0
- package/core/agents/frontend-specialist.md +743 -0
- package/core/agents/game-developer.md +162 -0
- package/core/agents/mobile-developer.md +377 -0
- package/core/agents/orchestrator.md +416 -0
- package/core/agents/penetration-tester.md +188 -0
- package/core/agents/performance-optimizer.md +187 -0
- package/core/agents/product-manager.md +112 -0
- package/core/agents/product-owner.md +95 -0
- package/core/agents/project-planner.md +470 -0
- package/core/agents/qa-automation-engineer.md +103 -0
- package/core/agents/security-auditor.md +170 -0
- package/core/agents/seo-specialist.md +111 -0
- package/core/agents/stitch-designer.md +190 -0
- package/core/agents/tdd-reviewer.md +282 -0
- package/core/agents/test-engineer.md +158 -0
- package/core/scripts/auto_preview.py +148 -0
- package/core/scripts/checklist.py +243 -0
- package/core/scripts/cost_report.py +149 -0
- package/core/scripts/doc-sync-check.py +461 -0
- package/core/scripts/parse_user_stories.py +79 -0
- package/core/scripts/prepare_notion_updates.py +172 -0
- package/core/scripts/print_create_payload.py +18 -0
- package/core/scripts/session_manager.py +120 -0
- package/core/scripts/task_complete.py +127 -0
- package/core/scripts/verify_all.py +327 -0
- package/core/skills/analytics-strategy/SKILL.md +128 -0
- package/core/skills/api-patterns/SKILL.md +81 -0
- package/core/skills/api-patterns/api-style.md +42 -0
- package/core/skills/api-patterns/auth.md +24 -0
- package/core/skills/api-patterns/documentation.md +26 -0
- package/core/skills/api-patterns/graphql.md +41 -0
- package/core/skills/api-patterns/rate-limiting.md +31 -0
- package/core/skills/api-patterns/response.md +37 -0
- package/core/skills/api-patterns/rest.md +40 -0
- package/core/skills/api-patterns/scripts/api_validator.py +211 -0
- package/core/skills/api-patterns/security-testing.md +122 -0
- package/core/skills/api-patterns/trpc.md +41 -0
- package/core/skills/api-patterns/versioning.md +22 -0
- package/core/skills/app-builder/SKILL.md +75 -0
- package/core/skills/app-builder/agent-coordination.md +71 -0
- package/core/skills/app-builder/feature-building.md +53 -0
- package/core/skills/app-builder/project-detection.md +34 -0
- package/core/skills/app-builder/scaffolding.md +118 -0
- package/core/skills/app-builder/tech-stack.md +40 -0
- package/core/skills/app-builder/templates/SKILL.md +39 -0
- package/core/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/core/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/core/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/core/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/core/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/core/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/core/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/core/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +82 -0
- package/core/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +100 -0
- package/core/skills/app-builder/templates/nextjs-static/TEMPLATE.md +106 -0
- package/core/skills/app-builder/templates/nuxt-app/TEMPLATE.md +101 -0
- package/core/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/core/skills/app-builder/templates/react-native-app/TEMPLATE.md +93 -0
- package/core/skills/architecture/SKILL.md +55 -0
- package/core/skills/architecture/context-discovery.md +43 -0
- package/core/skills/architecture/examples.md +94 -0
- package/core/skills/architecture/pattern-selection.md +68 -0
- package/core/skills/architecture/patterns-reference.md +50 -0
- package/core/skills/architecture/trade-off-analysis.md +77 -0
- package/core/skills/atomic-design/SKILL.md +282 -0
- package/core/skills/atomic-design/references/classification-guide.md +132 -0
- package/core/skills/atomic-design/references/quality-checklist.md +60 -0
- package/core/skills/atomic-design/references/stacks/stack-blade.md +254 -0
- package/core/skills/atomic-design/references/stacks/stack-nextjs.md +272 -0
- package/core/skills/atomic-design/references/stacks/stack-react.md +239 -0
- package/core/skills/atomic-design/references/stacks/stack-vue.md +224 -0
- package/core/skills/bash-linux/SKILL.md +199 -0
- package/core/skills/behavioral-modes/SKILL.md +242 -0
- package/core/skills/brainstorming/SKILL.md +163 -0
- package/core/skills/brainstorming/dynamic-questioning.md +373 -0
- package/core/skills/checkpointing-patterns/SKILL.md +163 -0
- package/core/skills/clean-code/SKILL.md +201 -0
- package/core/skills/code-review-checklist/SKILL.md +109 -0
- package/core/skills/code-truth-validation/SKILL.md +149 -0
- package/core/skills/component-library-discovery/SKILL.md +154 -0
- package/core/skills/content-strategy/SKILL.md +222 -0
- package/core/skills/context-budget/SKILL.md +155 -0
- package/core/skills/context-gathering-patterns/SKILL.md +278 -0
- package/core/skills/cost-tracking/SKILL.md +206 -0
- package/core/skills/database-design/SKILL.md +52 -0
- package/core/skills/database-design/database-selection.md +43 -0
- package/core/skills/database-design/indexing.md +39 -0
- package/core/skills/database-design/migrations.md +48 -0
- package/core/skills/database-design/optimization.md +36 -0
- package/core/skills/database-design/orm-selection.md +30 -0
- package/core/skills/database-design/schema-design.md +56 -0
- package/core/skills/database-design/scripts/schema_validator.py +172 -0
- package/core/skills/deployment-procedures/SKILL.md +295 -0
- package/core/skills/design-md/README.md +34 -0
- package/core/skills/design-md/SKILL.md +172 -0
- package/core/skills/design-md/examples/DESIGN.md +154 -0
- package/core/skills/design-system-enforcement/SKILL.md +339 -0
- package/core/skills/doc.md +177 -0
- package/core/skills/document-registry/SKILL.md +130 -0
- package/core/skills/documentation-publishing/SKILL.md +174 -0
- package/core/skills/documentation-templates/SKILL.md +194 -0
- package/core/skills/enhance-prompt/README.md +34 -0
- package/core/skills/enhance-prompt/SKILL.md +204 -0
- package/core/skills/enhance-prompt/references/KEYWORDS.md +114 -0
- package/core/skills/frontend-design/SKILL.md +430 -0
- package/core/skills/frontend-design/animation-guide.md +331 -0
- package/core/skills/frontend-design/color-system.md +311 -0
- package/core/skills/frontend-design/decision-trees.md +418 -0
- package/core/skills/frontend-design/motion-graphics.md +306 -0
- package/core/skills/frontend-design/scripts/accessibility_checker.py +183 -0
- package/core/skills/frontend-design/scripts/ux_audit.py +722 -0
- package/core/skills/frontend-design/typography-system.md +345 -0
- package/core/skills/frontend-design/ux-psychology.md +541 -0
- package/core/skills/frontend-design/visual-effects.md +383 -0
- package/core/skills/game-development/2d-games/SKILL.md +119 -0
- package/core/skills/game-development/3d-games/SKILL.md +135 -0
- package/core/skills/game-development/SKILL.md +167 -0
- package/core/skills/game-development/game-art/SKILL.md +185 -0
- package/core/skills/game-development/game-audio/SKILL.md +190 -0
- package/core/skills/game-development/game-design/SKILL.md +129 -0
- package/core/skills/game-development/mobile-games/SKILL.md +108 -0
- package/core/skills/game-development/multiplayer/SKILL.md +132 -0
- package/core/skills/game-development/pc-games/SKILL.md +144 -0
- package/core/skills/game-development/vr-ar/SKILL.md +123 -0
- package/core/skills/game-development/web-games/SKILL.md +150 -0
- package/core/skills/geo-fundamentals/SKILL.md +156 -0
- package/core/skills/geo-fundamentals/scripts/geo_checker.py +289 -0
- package/core/skills/git-workflow/SKILL.md +263 -0
- package/core/skills/history-check-patterns/SKILL.md +125 -0
- package/core/skills/i18n-localization/SKILL.md +154 -0
- package/core/skills/i18n-localization/scripts/i18n_checker.py +241 -0
- package/core/skills/integration-completeness/SKILL.md +219 -0
- package/core/skills/intelligent-routing/SKILL.md +370 -0
- package/core/skills/lint-and-validate/SKILL.md +45 -0
- package/core/skills/lint-and-validate/scripts/lint_runner.py +173 -0
- package/core/skills/lint-and-validate/scripts/type_coverage.py +173 -0
- package/core/skills/local-verification/SKILL.md +195 -0
- package/core/skills/mcp-builder/SKILL.md +176 -0
- package/core/skills/mobile-design/SKILL.md +394 -0
- package/core/skills/mobile-design/decision-trees.md +516 -0
- package/core/skills/mobile-design/mobile-backend.md +491 -0
- package/core/skills/mobile-design/mobile-color-system.md +420 -0
- package/core/skills/mobile-design/mobile-debugging.md +122 -0
- package/core/skills/mobile-design/mobile-design-thinking.md +357 -0
- package/core/skills/mobile-design/mobile-navigation.md +458 -0
- package/core/skills/mobile-design/mobile-performance.md +767 -0
- package/core/skills/mobile-design/mobile-testing.md +356 -0
- package/core/skills/mobile-design/mobile-typography.md +433 -0
- package/core/skills/mobile-design/platform-android.md +666 -0
- package/core/skills/mobile-design/platform-ios.md +561 -0
- package/core/skills/mobile-design/scripts/mobile_audit.py +670 -0
- package/core/skills/mobile-design/touch-psychology.md +537 -0
- package/core/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +312 -0
- package/core/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -0
- package/core/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -0
- package/core/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -0
- package/core/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
- package/core/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -0
- package/core/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -0
- package/core/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -0
- package/core/skills/nextjs-react-expert/SKILL.md +267 -0
- package/core/skills/nextjs-react-expert/scripts/convert_rules.py +222 -0
- package/core/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
- package/core/skills/nodejs-best-practices/SKILL.md +333 -0
- package/core/skills/notion-task-patterns/SKILL.md +2529 -0
- package/core/skills/page-specifications/SKILL.md +367 -0
- package/core/skills/parallel-agents/SKILL.md +175 -0
- package/core/skills/performance-profiling/SKILL.md +143 -0
- package/core/skills/performance-profiling/scripts/lighthouse_audit.py +76 -0
- package/core/skills/plan-writing/SKILL.md +190 -0
- package/core/skills/powershell-windows/SKILL.md +167 -0
- package/core/skills/project-foundation/SKILL.md +117 -0
- package/core/skills/project-setup/SKILL.md +141 -0
- package/core/skills/project-tracking-patterns/SKILL.md +357 -0
- package/core/skills/project-type-discovery/SKILL.md +239 -0
- package/core/skills/python-patterns/SKILL.md +441 -0
- package/core/skills/qa-test-generation/SKILL.md +156 -0
- package/core/skills/react-components/README.md +36 -0
- package/core/skills/react-components/SKILL.md +47 -0
- package/core/skills/react-components/examples/gold-standard-card.tsx +80 -0
- package/core/skills/react-components/package-lock.json +231 -0
- package/core/skills/react-components/package.json +16 -0
- package/core/skills/react-components/resources/architecture-checklist.md +15 -0
- package/core/skills/react-components/resources/component-template.tsx +37 -0
- package/core/skills/react-components/resources/stitch-api-reference.md +14 -0
- package/core/skills/react-components/resources/style-guide.json +27 -0
- package/core/skills/react-components/scripts/fetch-stitch.sh +30 -0
- package/core/skills/react-components/scripts/validate.js +68 -0
- package/core/skills/red-team-tactics/SKILL.md +199 -0
- package/core/skills/remotion/README.md +105 -0
- package/core/skills/remotion/SKILL.md +393 -0
- package/core/skills/remotion/examples/WalkthroughComposition.tsx +78 -0
- package/core/skills/remotion/examples/screens.json +56 -0
- package/core/skills/remotion/resources/composition-checklist.md +124 -0
- package/core/skills/remotion/resources/screen-slide-template.tsx +123 -0
- package/core/skills/remotion/scripts/download-stitch-asset.sh +38 -0
- package/core/skills/seo-fundamentals/SKILL.md +129 -0
- package/core/skills/seo-fundamentals/scripts/seo_checker.py +219 -0
- package/core/skills/server-management/SKILL.md +161 -0
- package/core/skills/session-resilience/SKILL.md +199 -0
- package/core/skills/shadcn-ui/README.md +248 -0
- package/core/skills/shadcn-ui/SKILL.md +326 -0
- package/core/skills/shadcn-ui/examples/auth-layout.tsx +177 -0
- package/core/skills/shadcn-ui/examples/data-table.tsx +313 -0
- package/core/skills/shadcn-ui/examples/form-pattern.tsx +177 -0
- package/core/skills/shadcn-ui/resources/component-catalog.md +481 -0
- package/core/skills/shadcn-ui/resources/customization-guide.md +516 -0
- package/core/skills/shadcn-ui/resources/migration-guide.md +463 -0
- package/core/skills/shadcn-ui/resources/setup-guide.md +412 -0
- package/core/skills/shadcn-ui/scripts/verify-setup.sh +134 -0
- package/core/skills/state-machine/SKILL.md +264 -0
- package/core/skills/stitch-loop/README.md +54 -0
- package/core/skills/stitch-loop/SKILL.md +203 -0
- package/core/skills/stitch-loop/examples/SITE.md +73 -0
- package/core/skills/stitch-loop/examples/next-prompt.md +25 -0
- package/core/skills/stitch-loop/resources/baton-schema.md +61 -0
- package/core/skills/stitch-loop/resources/site-template.md +104 -0
- package/core/skills/systematic-debugging/SKILL.md +109 -0
- package/core/skills/tailwind-patterns/SKILL.md +284 -0
- package/core/skills/tdd-validation/SKILL.md +243 -0
- package/core/skills/tdd-workflow/SKILL.md +284 -0
- package/core/skills/testing-patterns/SKILL.md +196 -0
- package/core/skills/testing-patterns/scripts/test_runner.py +219 -0
- package/core/skills/ui-ux-discovery/SKILL.md +329 -0
- package/core/skills/ui-validation/SKILL.md +190 -0
- package/core/skills/ui-validation/scripts/ui_antipattern_check.py +317 -0
- package/core/skills/verification-gate/SKILL.md +205 -0
- package/core/skills/vulnerability-scanner/SKILL.md +276 -0
- package/core/skills/vulnerability-scanner/checklists.md +121 -0
- package/core/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/core/skills/web-design-guidelines/SKILL.md +57 -0
- package/core/skills/webapp-testing/SKILL.md +187 -0
- package/core/skills/webapp-testing/scripts/playwright_runner.py +173 -0
- package/core/templates/ARCHITECTURE.template.md +407 -0
- package/core/templates/project-resources.example.json +71 -0
- package/core/workflows/atomic.md +182 -0
- package/core/workflows/brainstorm.md +134 -0
- package/core/workflows/check-task.md +242 -0
- package/core/workflows/copy-collect.md +306 -0
- package/core/workflows/create-agent.md +33 -0
- package/core/workflows/create-skill.md +39 -0
- package/core/workflows/create-workflow.md +33 -0
- package/core/workflows/create.md +92 -0
- package/core/workflows/debug.md +186 -0
- package/core/workflows/demand.md +443 -0
- package/core/workflows/deploy.md +260 -0
- package/core/workflows/discovery.md +267 -0
- package/core/workflows/document.md +272 -0
- package/core/workflows/ds-components.md +296 -0
- package/core/workflows/ds-init.md +58 -0
- package/core/workflows/ds-refactor.md +245 -0
- package/core/workflows/ds-references.md +197 -0
- package/core/workflows/ds-styleguide.md +237 -0
- package/core/workflows/ds-token-diff.md +103 -0
- package/core/workflows/ds-tokens.md +317 -0
- package/core/workflows/ds-validate.md +309 -0
- package/core/workflows/execute.md +483 -0
- package/core/workflows/extract-template.md +278 -0
- package/core/workflows/fix-failed-tests.md +160 -0
- package/core/workflows/init-project.md +386 -0
- package/core/workflows/legacy-project.md +849 -0
- package/core/workflows/log.md +97 -0
- package/core/workflows/new-project.md +610 -0
- package/core/workflows/new-project.md.bak +3292 -0
- package/core/workflows/new-task.md +404 -0
- package/core/workflows/orchestrate.md +237 -0
- package/core/workflows/page-build.md +296 -0
- package/core/workflows/plan.md +89 -0
- package/core/workflows/prd.md +255 -0
- package/core/workflows/preview.md +81 -0
- package/core/workflows/review-page.md +304 -0
- package/core/workflows/status.md +86 -0
- package/core/workflows/stitch.md +226 -0
- package/core/workflows/task-complete.md +473 -0
- package/core/workflows/task-update.md +163 -0
- package/core/workflows/tdd.md +344 -0
- package/core/workflows/test.md +251 -0
- package/core/workflows/ui-ux-pro-max.md +437 -0
- package/core/workflows/ux-mobile-optimize.md +262 -0
- package/core/workflows/ux-mobile-validate.md +297 -0
- package/engine-files/GEMINI.md +69 -0
- package/package.json +47 -0
- package/runtime-adapters/antigravity.js +26 -0
- package/runtime-adapters/claude.js +57 -0
- package/runtime-adapters/codex.js +51 -0
- package/runtime-adapters/copilot.js +51 -0
- package/runtime-adapters/cursor.js +51 -0
- package/runtime-adapters/gemini-cli.js +30 -0
- package/runtime-adapters/opencode.js +51 -0
- package/runtime-adapters/windsurf.js +51 -0
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: documentation-publishing
|
|
3
|
+
description: Publicação de documentação técnica e manual do usuário no Flyee. Discovery de databases, upsert, mapeamento de fluxos para guias.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Documentation Publishing
|
|
7
|
+
|
|
8
|
+
> **Publicação estruturada de documentação no Flyee (ou local) ao final de ciclos de projeto.**
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## 🎯 PROPÓSITO
|
|
13
|
+
|
|
14
|
+
Garantir que ao concluir trabalho em um escopo/módulo:
|
|
15
|
+
1. **Handover** e **Test Guide** são criados
|
|
16
|
+
2. **Docs técnicos** são publicados para devs (Database "Documentação Técnica")
|
|
17
|
+
3. **Guias de usuário** são publicados para operadores (Database "Manual do Usuário")
|
|
18
|
+
4. **Modo Local** registra docs criados sem chamadas a APIs Flyee
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 🔴 REGRAS OBRIGATÓRIAS
|
|
23
|
+
|
|
24
|
+
> [!CAUTION]
|
|
25
|
+
> **REGRA BLOQUEANTE:** A publicação tem **DUAS partes obrigatórias:**
|
|
26
|
+
> 1. Criar HANDOVER + TEST-GUIDE para o escopo
|
|
27
|
+
> 2. Publicar TODOS os docs (flow docs, TDD, DS, handover, test-guide)
|
|
28
|
+
>
|
|
29
|
+
> Uma sem a outra = **fase INCOMPLETA**.
|
|
30
|
+
|
|
31
|
+
#### Historical Lesson — Publicação Incompleta
|
|
32
|
+
|
|
33
|
+
> 🔴 **FALHA (api/ e admin/):** Agente criou HANDOVER + TEST-GUIDE mas **PULOU a publicação
|
|
34
|
+
> dos flow docs/TDD/DS no Flyee** (Database "Documentação Técnica"). Devs ficaram sem acesso
|
|
35
|
+
> à documentação completa. **Causa raiz:** instrução dizia "Documentação Final" sem mencionar
|
|
36
|
+
> publicação Flyee — agente interpretou como "só criar handover".
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
### 1. Criação de Handover e Test Guide
|
|
41
|
+
|
|
42
|
+
#### HANDOVER-{escopo}.md
|
|
43
|
+
|
|
44
|
+
Caminho: `docs/handover/{escopo}/HANDOVER-{escopo}.md`
|
|
45
|
+
|
|
46
|
+
| Seção | Conteúdo |
|
|
47
|
+
|-------|----------|
|
|
48
|
+
| Visão Geral | Stack, arquitetura, dependências |
|
|
49
|
+
| Fluxos Críticos | Resumo dos flow docs |
|
|
50
|
+
| Integrações | APIs externas, gateways, services |
|
|
51
|
+
| Débitos Resolvidos | Lista de melhorias implementadas |
|
|
52
|
+
| Débitos Pendentes | Itens não implementados do TDD |
|
|
53
|
+
| Decisões Técnicas | Decisões tomadas durante o projeto |
|
|
54
|
+
| Como Rodar | Setup local, env vars, comandos |
|
|
55
|
+
| Referências | Links para docs detalhados |
|
|
56
|
+
|
|
57
|
+
#### TEST-GUIDE-{escopo}.md
|
|
58
|
+
|
|
59
|
+
Caminho: `docs/tests/{escopo}/TEST-GUIDE-{escopo}.md`
|
|
60
|
+
|
|
61
|
+
| Seção | Conteúdo |
|
|
62
|
+
|-------|----------|
|
|
63
|
+
| Stack de Testes | Ferramentas, versões, config |
|
|
64
|
+
| Estrutura | Diretórios e organização |
|
|
65
|
+
| Mapa de Testes | Tests por domínio (cobertura atual) |
|
|
66
|
+
| Como Executar | Comandos para rodar testes |
|
|
67
|
+
| Patterns Usados | MSW, mocks, factories, etc |
|
|
68
|
+
| Troubleshooting | Problemas comuns e soluções |
|
|
69
|
+
| Expansão | Próximos testes prioritários |
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
### 2. Publicação de Documentação Técnica (Flyee)
|
|
74
|
+
|
|
75
|
+
> [!NOTE]
|
|
76
|
+
> **Se `Destino de Tasks = Local`:** Pular discovery e publicação Flyee.
|
|
77
|
+
> Registrar docs criados no arquivo de progresso com caminhos dos arquivos.
|
|
78
|
+
|
|
79
|
+
#### Passo 1: Discovery e Validação do Database
|
|
80
|
+
|
|
81
|
+
```json
|
|
82
|
+
// Buscar database "Documentação Técnica"
|
|
83
|
+
{
|
|
84
|
+
"query": "Documentação Técnica",
|
|
85
|
+
"filter": { "property": "object", "value": "data_source" }
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
> Se database ausente ou propriedades faltando → PARAR e notificar usuário.
|
|
90
|
+
|
|
91
|
+
#### Passo 2: Coletar Artefatos
|
|
92
|
+
|
|
93
|
+
| Fonte | Tipo | Publicar? |
|
|
94
|
+
|-------|------|-----------|
|
|
95
|
+
| Análise | Arquitetura (`CODEBASE-*.md`) | ✅ |
|
|
96
|
+
| Flow docs | Fluxos (`docs/flows/**/*.md`) | ✅ |
|
|
97
|
+
| TDD | Design (`docs/design/TDD-*.md`) | ✅ |
|
|
98
|
+
| Design System | DS (`design-system/MASTER.md`) | ✅ (se UI) |
|
|
99
|
+
| Testes | Cobertura (relatório) | ✅ |
|
|
100
|
+
| Handover | Handover (`docs/handover/**/*.md`) | ✅ |
|
|
101
|
+
| Test Guide | Testes (`docs/tests/**/*.md`) | ✅ |
|
|
102
|
+
|
|
103
|
+
#### Passo 3: Para Cada Artefato — Publicar
|
|
104
|
+
|
|
105
|
+
1. **Verificar upsert** — doc já existe no database? (query por Nome + Módulo)
|
|
106
|
+
2. **Ler conteúdo** do arquivo local
|
|
107
|
+
3. **Criar ou atualizar** página Flyee
|
|
108
|
+
4. **Propriedades:** Nome, Módulo, Tipo, Status, Última Atualização, Arquivo Local, Tasks Relacionadas
|
|
109
|
+
5. **Incluir histórico** referenciando tasks da database "Tarefas"
|
|
110
|
+
|
|
111
|
+
#### Passo 4: Gate de Saída
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
[ ] Database "Documentação Técnica" validado
|
|
115
|
+
[ ] Todos os artefatos publicados
|
|
116
|
+
[ ] Upsert verificado (sem duplicatas)
|
|
117
|
+
[ ] Histórico de atualizações em cada doc
|
|
118
|
+
[ ] Tasks relacionadas referenciadas
|
|
119
|
+
[ ] Arquivo de progresso atualizado
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
### 3. Publicação do Manual do Usuário (Flyee)
|
|
125
|
+
|
|
126
|
+
> [!CAUTION]
|
|
127
|
+
> **REGRA BLOQUEANTE:** Para cada fluxo publicado, DEVE existir uma versão
|
|
128
|
+
> em linguagem acessível. Sem código, sem jargão técnico.
|
|
129
|
+
|
|
130
|
+
> [!NOTE]
|
|
131
|
+
> **Se `Destino de Tasks = Local`:** Gerar guias como arquivos em
|
|
132
|
+
> `docs/user-guides/{escopo}/` e registrar no arquivo de progresso.
|
|
133
|
+
|
|
134
|
+
#### Passo 1: Discovery do Database
|
|
135
|
+
|
|
136
|
+
```json
|
|
137
|
+
{
|
|
138
|
+
"query": "Manual do Usuário",
|
|
139
|
+
"filter": { "property": "object", "value": "data_source" }
|
|
140
|
+
}
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
> Se database ausente → PARAR e notificar usuário.
|
|
144
|
+
|
|
145
|
+
#### Passo 2: Mapeamento Fluxo → Guia
|
|
146
|
+
|
|
147
|
+
Para cada fluxo técnico publicado, gerar versão em linguagem simples.
|
|
148
|
+
|
|
149
|
+
#### Passo 3: Para Cada Guia — Publicar
|
|
150
|
+
|
|
151
|
+
1. **Verificar upsert** — guia já existe? (query por Nome)
|
|
152
|
+
2. **Gerar conteúdo** em linguagem simples
|
|
153
|
+
3. **Criar ou atualizar** página com template de guia
|
|
154
|
+
4. **Propriedades:** Nome, Seção, Status, Público-alvo
|
|
155
|
+
|
|
156
|
+
#### Passo 4: Gate de Saída
|
|
157
|
+
|
|
158
|
+
```
|
|
159
|
+
[ ] Database "Manual do Usuário" validado
|
|
160
|
+
[ ] Todos os fluxos mapeados para guias
|
|
161
|
+
[ ] Upsert verificado (sem duplicatas)
|
|
162
|
+
[ ] Conteúdo sem jargão técnico
|
|
163
|
+
[ ] Arquivo de progresso atualizado
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
## 🔗 WORKFLOWS QUE USAM ESTA SKILL
|
|
169
|
+
|
|
170
|
+
| Workflow | Quando usar |
|
|
171
|
+
|----------|-------------|
|
|
172
|
+
| `/legacy-project` | Phases 8 + 8.5 (handover + publicação) |
|
|
173
|
+
| `/new-project` | Phase 7 (documentação final) |
|
|
174
|
+
| `/document` | Publicação standalone de docs |
|
|
@@ -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.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Stitch Enhance Prompt Skill
|
|
2
|
+
|
|
3
|
+
## Install
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npx add-skill google-labs-code/stitch-skills --skill enhance-prompt --global
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Example Prompt
|
|
10
|
+
|
|
11
|
+
```text
|
|
12
|
+
Enhance my prompt "make me a login page" for better Stitch generation results.
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Skill Structure
|
|
16
|
+
|
|
17
|
+
This repository follows the **Agent Skills** open standard. Each skill is self-contained with its own logic, workflow, and reference materials.
|
|
18
|
+
|
|
19
|
+
```text
|
|
20
|
+
enhance-prompt/
|
|
21
|
+
├── SKILL.md — Core instructions & workflow
|
|
22
|
+
├── references/ — UI/UX vocabulary and adjective palettes
|
|
23
|
+
└── README.md — This file
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## How it Works
|
|
27
|
+
|
|
28
|
+
When activated, the agent follows a prompt enhancement pipeline:
|
|
29
|
+
|
|
30
|
+
1. **Assessment**: Evaluates the input for missing elements (platform, structure, visual style, colors).
|
|
31
|
+
2. **DESIGN.md Check**: Looks for an existing design system to inject; recommends creating one if missing.
|
|
32
|
+
3. **Enhancement**: Applies UI/UX keywords, vibe adjectives, and structured page sections.
|
|
33
|
+
4. **Formatting**: Outputs a Stitch-optimized prompt with design system block and numbered structure.
|
|
34
|
+
5. **Delivery**: Returns enhanced text for user review, with optional file output.
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: enhance-prompt
|
|
3
|
+
description: Transforms vague UI ideas into polished, Stitch-optimized prompts. Enhances specificity, adds UI/UX keywords, injects design system context, and structures output for better generation results.
|
|
4
|
+
allowed-tools:
|
|
5
|
+
- "Read"
|
|
6
|
+
- "Write"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Enhance Prompt for Stitch
|
|
10
|
+
|
|
11
|
+
You are a **Stitch Prompt Engineer**. Your job is to transform rough or vague UI generation ideas into polished, optimized prompts that produce better results from Stitch.
|
|
12
|
+
|
|
13
|
+
## Prerequisites
|
|
14
|
+
|
|
15
|
+
Before enhancing prompts, consult the official Stitch documentation for the latest best practices:
|
|
16
|
+
|
|
17
|
+
- **Stitch Effective Prompting Guide**: https://stitch.withgoogle.com/docs/learn/prompting/
|
|
18
|
+
|
|
19
|
+
This guide contains up-to-date recommendations that may supersede or complement the patterns in this skill.
|
|
20
|
+
|
|
21
|
+
## When to Use This Skill
|
|
22
|
+
|
|
23
|
+
Activate when a user wants to:
|
|
24
|
+
- Polish a UI prompt before sending to Stitch
|
|
25
|
+
- Improve a prompt that produced poor results
|
|
26
|
+
- Add design system consistency to a simple idea
|
|
27
|
+
- Structure a vague concept into an actionable prompt
|
|
28
|
+
|
|
29
|
+
## Enhancement Pipeline
|
|
30
|
+
|
|
31
|
+
Follow these steps to enhance any prompt:
|
|
32
|
+
|
|
33
|
+
### Step 1: Assess the Input
|
|
34
|
+
|
|
35
|
+
Evaluate what's missing from the user's prompt:
|
|
36
|
+
|
|
37
|
+
| Element | Check for | If missing... |
|
|
38
|
+
|---------|-----------|---------------|
|
|
39
|
+
| **Platform** | "web", "mobile", "desktop" | Add based on context or ask |
|
|
40
|
+
| **Page type** | "landing page", "dashboard", "form" | Infer from description |
|
|
41
|
+
| **Structure** | Numbered sections/components | Create logical page structure |
|
|
42
|
+
| **Visual style** | Adjectives, mood, vibe | Add appropriate descriptors |
|
|
43
|
+
| **Colors** | Specific values or roles | Add design system or suggest |
|
|
44
|
+
| **Components** | UI-specific terms | Translate to proper keywords |
|
|
45
|
+
|
|
46
|
+
### Step 2: Check for DESIGN.md
|
|
47
|
+
|
|
48
|
+
Look for a `DESIGN.md` file in the current project:
|
|
49
|
+
|
|
50
|
+
**If DESIGN.md exists:**
|
|
51
|
+
1. Read the file to extract the design system block
|
|
52
|
+
2. Include the color palette, typography, and component styles
|
|
53
|
+
3. Format as a "DESIGN SYSTEM (REQUIRED)" section in the output
|
|
54
|
+
|
|
55
|
+
**If DESIGN.md does not exist:**
|
|
56
|
+
1. Add this note at the end of the enhanced prompt:
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
---
|
|
60
|
+
💡 **Tip:** For consistent designs across multiple screens, create a DESIGN.md
|
|
61
|
+
file using the `design-md` skill. This ensures all generated pages share the
|
|
62
|
+
same visual language.
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Step 3: Apply Enhancements
|
|
66
|
+
|
|
67
|
+
Transform the input using these techniques:
|
|
68
|
+
|
|
69
|
+
#### A. Add UI/UX Keywords
|
|
70
|
+
|
|
71
|
+
Replace vague terms with specific component names:
|
|
72
|
+
|
|
73
|
+
| Vague | Enhanced |
|
|
74
|
+
|-------|----------|
|
|
75
|
+
| "menu at the top" | "navigation bar with logo and menu items" |
|
|
76
|
+
| "button" | "primary call-to-action button" |
|
|
77
|
+
| "list of items" | "card grid layout" or "vertical list with thumbnails" |
|
|
78
|
+
| "form" | "form with labeled input fields and submit button" |
|
|
79
|
+
| "picture area" | "hero section with full-width image" |
|
|
80
|
+
|
|
81
|
+
#### B. Amplify the Vibe
|
|
82
|
+
|
|
83
|
+
Add descriptive adjectives to set the mood:
|
|
84
|
+
|
|
85
|
+
| Basic | Enhanced |
|
|
86
|
+
|-------|----------|
|
|
87
|
+
| "modern" | "clean, minimal, with generous whitespace" |
|
|
88
|
+
| "professional" | "sophisticated, trustworthy, with subtle shadows" |
|
|
89
|
+
| "fun" | "vibrant, playful, with rounded corners and bold colors" |
|
|
90
|
+
| "dark mode" | "dark theme with high-contrast accents on deep backgrounds" |
|
|
91
|
+
|
|
92
|
+
#### C. Structure the Page
|
|
93
|
+
|
|
94
|
+
Organize content into numbered sections:
|
|
95
|
+
|
|
96
|
+
```markdown
|
|
97
|
+
**Page Structure:**
|
|
98
|
+
1. **Header:** Navigation with logo and menu items
|
|
99
|
+
2. **Hero Section:** Headline, subtext, and primary CTA
|
|
100
|
+
3. **Content Area:** [Describe the main content]
|
|
101
|
+
4. **Footer:** Links, social icons, copyright
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
#### D. Format Colors Properly
|
|
105
|
+
|
|
106
|
+
When colors are mentioned, format them as:
|
|
107
|
+
```
|
|
108
|
+
Descriptive Name (#hexcode) for functional role
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Examples:
|
|
112
|
+
- "Deep Ocean Blue (#1a365d) for primary buttons and links"
|
|
113
|
+
- "Warm Cream (#faf5f0) for page background"
|
|
114
|
+
- "Soft Gray (#6b7280) for secondary text"
|
|
115
|
+
|
|
116
|
+
### Step 4: Format the Output
|
|
117
|
+
|
|
118
|
+
Structure the enhanced prompt in this order:
|
|
119
|
+
|
|
120
|
+
```markdown
|
|
121
|
+
[One-line description of the page purpose and vibe]
|
|
122
|
+
|
|
123
|
+
**DESIGN SYSTEM (REQUIRED):**
|
|
124
|
+
- Platform: [Web/Mobile], [Desktop/Mobile]-first
|
|
125
|
+
- Theme: [Light/Dark], [style descriptors]
|
|
126
|
+
- Background: [Color description] (#hex)
|
|
127
|
+
- Primary Accent: [Color description] (#hex) for [role]
|
|
128
|
+
- Text Primary: [Color description] (#hex)
|
|
129
|
+
- [Additional design tokens...]
|
|
130
|
+
|
|
131
|
+
**Page Structure:**
|
|
132
|
+
1. **[Section]:** [Description]
|
|
133
|
+
2. **[Section]:** [Description]
|
|
134
|
+
...
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Output Options
|
|
138
|
+
|
|
139
|
+
**Default:** Return the enhanced prompt as text for the user to copy.
|
|
140
|
+
|
|
141
|
+
**Optional file output:** If the user requests, write to a file:
|
|
142
|
+
- `next-prompt.md` — for use with the `stitch-loop` skill
|
|
143
|
+
- Custom filename specified by user
|
|
144
|
+
|
|
145
|
+
## Examples
|
|
146
|
+
|
|
147
|
+
### Example 1: Vague Input → Structured Prompt
|
|
148
|
+
|
|
149
|
+
**User input:**
|
|
150
|
+
> "make me a login page"
|
|
151
|
+
|
|
152
|
+
**Enhanced output:**
|
|
153
|
+
```markdown
|
|
154
|
+
A clean, trustworthy login page with a centered form and subtle branding.
|
|
155
|
+
|
|
156
|
+
**DESIGN SYSTEM (REQUIRED):**
|
|
157
|
+
- Platform: Web, Desktop-first
|
|
158
|
+
- Theme: Light, minimal, professional
|
|
159
|
+
- Background: Clean White (#ffffff)
|
|
160
|
+
- Surface: Soft Gray (#f9fafb) for form card
|
|
161
|
+
- Primary Accent: Deep Blue (#2563eb) for submit button and links
|
|
162
|
+
- Text Primary: Near Black (#111827) for headings
|
|
163
|
+
- Text Secondary: Medium Gray (#6b7280) for labels
|
|
164
|
+
- Buttons: Subtly rounded (8px), full-width on form
|
|
165
|
+
- Cards: Gently rounded (12px), soft shadow for elevation
|
|
166
|
+
|
|
167
|
+
**Page Structure:**
|
|
168
|
+
1. **Header:** Minimal logo, centered
|
|
169
|
+
2. **Login Card:** Centered form with email, password fields, "Forgot password?" link
|
|
170
|
+
3. **Submit Button:** Primary blue "Sign In" button
|
|
171
|
+
4. **Footer:** "Don't have an account? Sign up" link
|
|
172
|
+
|
|
173
|
+
---
|
|
174
|
+
💡 **Tip:** For consistent designs across multiple screens, create a DESIGN.md
|
|
175
|
+
file using the `design-md` skill.
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### Example 2: Feature Request → Targeted Edit
|
|
179
|
+
|
|
180
|
+
**User input:**
|
|
181
|
+
> "add a search bar"
|
|
182
|
+
|
|
183
|
+
**Enhanced output:**
|
|
184
|
+
```markdown
|
|
185
|
+
Add a search bar to the header navigation.
|
|
186
|
+
|
|
187
|
+
**Specific changes:**
|
|
188
|
+
- Location: Header, right side before user avatar
|
|
189
|
+
- Style: Pill-shaped input with subtle gray background (#f3f4f6)
|
|
190
|
+
- Icon: Magnifying glass icon on the left, inside the input
|
|
191
|
+
- Placeholder: "Search..." in light gray (#9ca3af)
|
|
192
|
+
- Behavior: Expands on focus with subtle shadow
|
|
193
|
+
- Width: 240px default, 320px on focus
|
|
194
|
+
|
|
195
|
+
**Context:** This is a targeted edit. Make only this change while preserving all existing elements.
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
## Tips for Best Results
|
|
199
|
+
|
|
200
|
+
1. **Be specific early** — Vague inputs need more enhancement
|
|
201
|
+
2. **Match the user's intent** — Don't over-design if they want simple
|
|
202
|
+
3. **Keep it structured** — Numbered sections help Stitch understand hierarchy
|
|
203
|
+
4. **Include the design system** — Consistency is key for multi-page projects
|
|
204
|
+
5. **One change at a time for edits** — Don't bundle unrelated changes
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# UI/UX Keywords Reference
|
|
2
|
+
|
|
3
|
+
Progressive disclosure reference for common UI terminology and adjective palettes.
|
|
4
|
+
|
|
5
|
+
## Component Keywords
|
|
6
|
+
|
|
7
|
+
### Navigation
|
|
8
|
+
- navigation bar, nav menu, header
|
|
9
|
+
- breadcrumbs, tabs, sidebar
|
|
10
|
+
- hamburger menu, dropdown menu
|
|
11
|
+
- back button, close button
|
|
12
|
+
|
|
13
|
+
### Content Containers
|
|
14
|
+
- hero section, hero banner
|
|
15
|
+
- card, card grid, tile
|
|
16
|
+
- modal, dialog, popup
|
|
17
|
+
- accordion, collapsible section
|
|
18
|
+
- carousel, slider
|
|
19
|
+
|
|
20
|
+
### Forms
|
|
21
|
+
- input field, text input
|
|
22
|
+
- dropdown, select menu
|
|
23
|
+
- checkbox, radio button
|
|
24
|
+
- toggle switch
|
|
25
|
+
- date picker, time picker
|
|
26
|
+
- search bar, search input
|
|
27
|
+
- submit button, form actions
|
|
28
|
+
|
|
29
|
+
### Calls to Action
|
|
30
|
+
- primary button, secondary button
|
|
31
|
+
- ghost button, text link
|
|
32
|
+
- floating action button (FAB)
|
|
33
|
+
- icon button
|
|
34
|
+
|
|
35
|
+
### Feedback
|
|
36
|
+
- toast notification, snackbar
|
|
37
|
+
- alert banner, warning message
|
|
38
|
+
- loading spinner, skeleton loader
|
|
39
|
+
- progress bar, step indicator
|
|
40
|
+
|
|
41
|
+
### Layout
|
|
42
|
+
- grid layout, flexbox
|
|
43
|
+
- sidebar layout, split view
|
|
44
|
+
- sticky header, fixed footer
|
|
45
|
+
- full-width, contained width
|
|
46
|
+
- centered content, max-width container
|
|
47
|
+
|
|
48
|
+
## Adjective Palettes
|
|
49
|
+
|
|
50
|
+
### Minimal / Clean
|
|
51
|
+
- minimal, clean, uncluttered
|
|
52
|
+
- generous whitespace, breathing room
|
|
53
|
+
- subtle, understated, refined
|
|
54
|
+
- simple, focused, distraction-free
|
|
55
|
+
|
|
56
|
+
### Professional / Corporate
|
|
57
|
+
- sophisticated, polished, trustworthy
|
|
58
|
+
- corporate, business-like, formal
|
|
59
|
+
- subtle shadows, clean lines
|
|
60
|
+
- structured, organized, hierarchical
|
|
61
|
+
|
|
62
|
+
### Playful / Fun
|
|
63
|
+
- vibrant, colorful, energetic
|
|
64
|
+
- rounded corners, soft edges
|
|
65
|
+
- bold, expressive, dynamic
|
|
66
|
+
- friendly, approachable, warm
|
|
67
|
+
|
|
68
|
+
### Premium / Luxury
|
|
69
|
+
- elegant, luxurious, high-end
|
|
70
|
+
- dramatic, bold contrasts
|
|
71
|
+
- sleek, modern, cutting-edge
|
|
72
|
+
- exclusive, boutique, curated
|
|
73
|
+
|
|
74
|
+
### Dark Mode
|
|
75
|
+
- dark theme, night mode
|
|
76
|
+
- high-contrast accents
|
|
77
|
+
- soft glows, subtle highlights
|
|
78
|
+
- deep backgrounds, muted surfaces
|
|
79
|
+
|
|
80
|
+
### Organic / Natural
|
|
81
|
+
- earthy tones, natural colors
|
|
82
|
+
- warm, inviting, cozy
|
|
83
|
+
- textured, tactile, handcrafted
|
|
84
|
+
- flowing, organic shapes
|
|
85
|
+
|
|
86
|
+
## Color Role Terminology
|
|
87
|
+
|
|
88
|
+
### Backgrounds
|
|
89
|
+
- page background, canvas
|
|
90
|
+
- surface color, card background
|
|
91
|
+
- overlay, scrim
|
|
92
|
+
|
|
93
|
+
### Text
|
|
94
|
+
- primary text, heading color
|
|
95
|
+
- secondary text, body copy
|
|
96
|
+
- muted text, placeholder
|
|
97
|
+
- inverse text (on dark backgrounds)
|
|
98
|
+
|
|
99
|
+
### Accents
|
|
100
|
+
- primary accent, brand color
|
|
101
|
+
- secondary accent, highlight
|
|
102
|
+
- success, error, warning colors
|
|
103
|
+
- hover state, active state
|
|
104
|
+
|
|
105
|
+
## Shape Descriptions
|
|
106
|
+
|
|
107
|
+
| Technical | Natural Language |
|
|
108
|
+
|-----------|------------------|
|
|
109
|
+
| `rounded-none` | sharp, squared-off edges |
|
|
110
|
+
| `rounded-sm` | slightly softened corners |
|
|
111
|
+
| `rounded-md` | gently rounded corners |
|
|
112
|
+
| `rounded-lg` | generously rounded corners |
|
|
113
|
+
| `rounded-xl` | very rounded, pillow-like |
|
|
114
|
+
| `rounded-full` | pill-shaped, circular |
|