cfsa-antigravity 3.0.2 → 3.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/README.md +27 -10
- package/bin/cli.mjs +7 -6
- package/package.json +1 -1
- package/template/.agent/PRDS/codex-runtime-support.md +2 -2
- package/template/.agent/TASKS/codex-runtime-support.md +2 -2
- package/template/.agent/instructions/workflow.md +3 -3
- package/template/.agent/kit-sync.md +3 -3
- package/template/.agent/rules/completion-checklist.md +3 -3
- package/template/.agent/skills/parallel-agents/SKILL.md +1 -1
- package/template/.agent/skills/session-continuity/SKILL.md +6 -6
- package/template/.agent/skills/session-continuity/protocols/01-session-resumption.md +1 -1
- package/template/.agent/skills/session-continuity/protocols/02-progress-generation.md +3 -3
- package/template/.agent/skills/session-continuity/protocols/03-progress-update.md +4 -4
- package/template/.agent/skills/session-continuity/protocols/07-spec-pipeline-generation.md +1 -1
- package/template/.agent/skills/session-continuity/protocols/08-spec-pipeline-update.md +2 -2
- package/template/.agent/skills/session-continuity/protocols/11-parallel-synthesis.md +1 -1
- package/template/.agent/workflows/create-prd-architecture.md +2 -2
- package/template/.agent/workflows/create-prd-design-system.md +2 -2
- package/template/.agent/workflows/create-prd-security.md +2 -2
- package/template/.agent/workflows/create-prd-stack.md +2 -2
- package/template/.agent/workflows/create-prd.md +2 -2
- package/template/.agent/workflows/decompose-architecture-validate.md +1 -1
- package/template/.agent/workflows/decompose-architecture.md +2 -2
- package/template/.agent/workflows/ideate.md +2 -2
- package/template/.agent/workflows/implement-slice-setup.md +1 -1
- package/template/.agent/workflows/implement-slice-tdd.md +3 -3
- package/template/.agent/workflows/implement-slice.md +2 -2
- package/template/.agent/workflows/plan-phase-preflight.md +2 -2
- package/template/.agent/workflows/plan-phase-write.md +2 -2
- package/template/.agent/workflows/plan-phase.md +2 -2
- package/template/.agent/workflows/setup-workspace.md +2 -2
- package/template/.agent/workflows/update-architecture-map.md +1 -1
- package/template/.agent/workflows/validate-phase-quality.md +1 -1
- package/template/.agent/workflows/validate-phase-readiness.md +2 -2
- package/template/.agent/workflows/validate-phase.md +2 -2
- package/template/.agent/workflows/verify-infrastructure.md +1 -1
- package/template/.agent/workflows/write-architecture-spec-deepen.md +3 -3
- package/template/.agent/workflows/write-architecture-spec-design.md +1 -1
- package/template/.agent/workflows/write-architecture-spec.md +3 -3
- package/template/.agent/workflows/write-be-spec-classify.md +1 -1
- package/template/.agent/workflows/write-be-spec-write.md +3 -3
- package/template/.agent/workflows/write-be-spec.md +3 -3
- package/template/.agent/workflows/write-fe-spec-classify.md +1 -1
- package/template/.agent/workflows/write-fe-spec-write.md +2 -2
- package/template/.agent/workflows/write-fe-spec.md +3 -3
- package/template/.claude/README.md +3 -1
- package/template/.claude/instructions/workflow.md +3 -3
- package/template/.claude/kit-sync.md +3 -3
- package/template/.claude/rules/completion-checklist.md +3 -3
- package/template/.claude/skills/parallel-agents/SKILL.md +1 -1
- package/template/.claude/skills/plan-phase/SKILL.md +2 -2
- package/template/.claude/skills/plan-phase-preflight/SKILL.md +2 -2
- package/template/.claude/skills/session-continuity/SKILL.md +6 -6
- package/template/.claude/skills/session-continuity/protocols/01-session-resumption.md +1 -1
- package/template/.claude/skills/session-continuity/protocols/02-progress-generation.md +3 -3
- package/template/.claude/skills/session-continuity/protocols/03-progress-update.md +4 -4
- package/template/.claude/skills/session-continuity/protocols/07-spec-pipeline-generation.md +1 -1
- package/template/.claude/skills/session-continuity/protocols/08-spec-pipeline-update.md +2 -2
- package/template/.claude/skills/session-continuity/protocols/11-parallel-synthesis.md +1 -1
- package/template/.claude/skills/setup/setup-cfsa.md +1 -1
- package/template/.claude/skills/write-architecture-spec/SKILL.md +2 -2
- package/template/.claude/skills/write-architecture-spec-deepen/SKILL.md +1 -1
- package/template/.claude/skills/write-architecture-spec-design/SKILL.md +1 -1
- package/template/.claude/skills/write-be-spec/SKILL.md +3 -3
- package/template/.claude/skills/write-be-spec-classify/SKILL.md +1 -1
- package/template/.claude/skills/write-be-spec-write/SKILL.md +1 -1
- package/template/.claude/skills/write-fe-spec/SKILL.md +3 -3
- package/template/.claude/skills/write-fe-spec-write/SKILL.md +1 -1
- package/template/.codex/README.md +99 -0
- package/template/.codex/instructions/commands.md +24 -0
- package/template/.codex/instructions/example.md +21 -0
- package/template/.codex/instructions/patterns.md +61 -0
- package/template/.codex/instructions/structure.md +29 -0
- package/template/.codex/instructions/tech-stack.md +93 -0
- package/template/.codex/instructions/workflow.md +64 -0
- package/template/.codex/kit-sync.md +6 -0
- package/template/.codex/rules/boundary-not-placeholder.md +146 -0
- package/template/.codex/rules/completion-checklist.md +60 -0
- package/template/.codex/rules/debug-by-test.md +49 -0
- package/template/.codex/rules/decision-classification.md +113 -0
- package/template/.codex/rules/extensibility.md +52 -0
- package/template/.codex/rules/memory-capture.md +84 -0
- package/template/.codex/rules/question-vs-command.md +91 -0
- package/template/.codex/rules/security-first.md +54 -0
- package/template/.codex/rules/single-question.md +59 -0
- package/template/.codex/rules/skill-mcp-first.md +45 -0
- package/template/.codex/rules/source-before-ask.md +93 -0
- package/template/.codex/rules/specificity-standards.md +64 -0
- package/template/.codex/rules/tdd-contract-first.md +67 -0
- package/template/.codex/rules/vertical-slices.md +83 -0
- package/template/.codex/skill-library/MANIFEST.md +498 -0
- package/template/.codex/skill-library/README.md +38 -0
- package/template/.codex/skill-library/meta/claude-code/README.md +9 -0
- package/template/.codex/skill-library/meta/claude-code/agent-development/SKILL.md +415 -0
- package/template/.codex/skill-library/meta/claude-code/hook-development/SKILL.md +712 -0
- package/template/.codex/skill-library/meta/claude-code/plugin-structure/SKILL.md +476 -0
- package/template/.codex/skill-library/meta/mcp-builder/SKILL.md +236 -0
- package/template/.codex/skill-library/meta/product-marketing-context/SKILL.md +241 -0
- package/template/.codex/skill-library/meta/tmux-processes/SKILL.md +210 -0
- package/template/.codex/skill-library/meta/using-tmux-for-interactive-commands/SKILL.md +178 -0
- package/template/.codex/skill-library/stack/3d/threejs-pro/SKILL.md +300 -0
- package/template/.codex/skill-library/stack/ai/ai-sdk/SKILL.md +77 -0
- package/template/.codex/skill-library/stack/ai/langchain/SKILL.md +530 -0
- package/template/.codex/skill-library/stack/ai/ollama/SKILL.md +321 -0
- package/template/.codex/skill-library/stack/ai/openai-sdk/SKILL.md +549 -0
- package/template/.codex/skill-library/stack/analytics/google-analytics/SKILL.md +153 -0
- package/template/.codex/skill-library/stack/api/graphql/SKILL.md +1061 -0
- package/template/.codex/skill-library/stack/api/trpc/SKILL.md +576 -0
- package/template/.codex/skill-library/stack/auth/authjs/SKILL.md +569 -0
- package/template/.codex/skill-library/stack/auth/clerk/SKILL.md +590 -0
- package/template/.codex/skill-library/stack/auth/firebase-auth/SKILL.md +734 -0
- package/template/.codex/skill-library/stack/auth/lucia/SKILL.md +230 -0
- package/template/.codex/skill-library/stack/auth/supabase-auth/SKILL.md +293 -0
- package/template/.codex/skill-library/stack/cms/payload-cms/SKILL.md +573 -0
- package/template/.codex/skill-library/stack/cms/shopify/SKILL.md +1193 -0
- package/template/.codex/skill-library/stack/cms/wordpress/SKILL.md +1104 -0
- package/template/.codex/skill-library/stack/css/sass-scss/SKILL.md +1121 -0
- package/template/.codex/skill-library/stack/css/tailwind-css-patterns/SKILL.md +863 -0
- package/template/.codex/skill-library/stack/css/tailwind-design-system/SKILL.md +490 -0
- package/template/.codex/skill-library/stack/css/vanilla-css/SKILL.md +1078 -0
- package/template/.codex/skill-library/stack/databases/clickhouse/SKILL.md +311 -0
- package/template/.codex/skill-library/stack/databases/influxdb/SKILL.md +280 -0
- package/template/.codex/skill-library/stack/databases/lancedb/SKILL.md +415 -0
- package/template/.codex/skill-library/stack/databases/mongodb/SKILL.md +1169 -0
- package/template/.codex/skill-library/stack/databases/neo4j/SKILL.md +839 -0
- package/template/.codex/skill-library/stack/databases/pgvector/SKILL.md +241 -0
- package/template/.codex/skill-library/stack/databases/pinecone/SKILL.md +212 -0
- package/template/.codex/skill-library/stack/databases/postgresql/SKILL.md +658 -0
- package/template/.codex/skill-library/stack/databases/qdrant/SKILL.md +312 -0
- package/template/.codex/skill-library/stack/databases/redis/SKILL.md +1079 -0
- package/template/.codex/skill-library/stack/databases/spacetimedb/SKILL.md +532 -0
- package/template/.codex/skill-library/stack/databases/sqlite/SKILL.md +1132 -0
- package/template/.codex/skill-library/stack/databases/supabase/SKILL.md +640 -0
- package/template/.codex/skill-library/stack/databases/surrealdb-expert/SKILL.md +945 -0
- package/template/.codex/skill-library/stack/databases/timescaledb/SKILL.md +745 -0
- package/template/.codex/skill-library/stack/databases/weaviate/SKILL.md +218 -0
- package/template/.codex/skill-library/stack/devops/git-advanced/SKILL.md +972 -0
- package/template/.codex/skill-library/stack/devops/git-workflow/SKILL.md +420 -0
- package/template/.codex/skill-library/stack/devops/github-actions/SKILL.md +554 -0
- package/template/.codex/skill-library/stack/devops/kubernetes/SKILL.md +950 -0
- package/template/.codex/skill-library/stack/devops/nginx/SKILL.md +841 -0
- package/template/.codex/skill-library/stack/devops/terraform/SKILL.md +860 -0
- package/template/.codex/skill-library/stack/email/resend/SKILL.md +391 -0
- package/template/.codex/skill-library/stack/extensions/chrome-extension/SKILL.md +375 -0
- package/template/.codex/skill-library/stack/extensions/plasmo/SKILL.md +195 -0
- package/template/.codex/skill-library/stack/extensions/vscode-extension/SKILL.md +453 -0
- package/template/.codex/skill-library/stack/extensions/wxt/SKILL.md +216 -0
- package/template/.codex/skill-library/stack/feature-flags/flagsmith/SKILL.md +187 -0
- package/template/.codex/skill-library/stack/feature-flags/launchdarkly/SKILL.md +183 -0
- package/template/.codex/skill-library/stack/feature-flags/posthog-flags/SKILL.md +189 -0
- package/template/.codex/skill-library/stack/frameworks/astro-framework/SKILL.md +162 -0
- package/template/.codex/skill-library/stack/frameworks/electron/SKILL.md +1286 -0
- package/template/.codex/skill-library/stack/frameworks/fastapi/SKILL.md +650 -0
- package/template/.codex/skill-library/stack/frameworks/hono/SKILL.md +90 -0
- package/template/.codex/skill-library/stack/frameworks/nestjs/SKILL.md +878 -0
- package/template/.codex/skill-library/stack/frameworks/nextjs/SKILL.md +635 -0
- package/template/.codex/skill-library/stack/frameworks/nuxt/SKILL.md +564 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/SKILL.md +81 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/events.md +353 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/migration.md +339 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/performance.md +443 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/runes.md +394 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/snippets.md +291 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/sveltekit.md +401 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/typescript.md +305 -0
- package/template/.codex/skill-library/stack/frameworks/sveltekit/SKILL.md +614 -0
- package/template/.codex/skill-library/stack/frameworks/tauri/SKILL.md +920 -0
- package/template/.codex/skill-library/stack/gamedev/godot/SKILL.md +1032 -0
- package/template/.codex/skill-library/stack/gamedev/unity/SKILL.md +1175 -0
- package/template/.codex/skill-library/stack/hosting/aws/SKILL.md +467 -0
- package/template/.codex/skill-library/stack/hosting/cloudflare/SKILL.md +201 -0
- package/template/.codex/skill-library/stack/hosting/docker-expert/SKILL.md +409 -0
- package/template/.codex/skill-library/stack/hosting/vercel/SKILL.md +484 -0
- package/template/.codex/skill-library/stack/languages/bash-scripting/SKILL.md +773 -0
- package/template/.codex/skill-library/stack/languages/c-cpp/SKILL.md +712 -0
- package/template/.codex/skill-library/stack/languages/gdscript/SKILL.md +789 -0
- package/template/.codex/skill-library/stack/languages/go/SKILL.md +664 -0
- package/template/.codex/skill-library/stack/languages/java/SKILL.md +778 -0
- package/template/.codex/skill-library/stack/languages/kotlin/SKILL.md +665 -0
- package/template/.codex/skill-library/stack/languages/python/SKILL.md +678 -0
- package/template/.codex/skill-library/stack/languages/rust/SKILL.md +673 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/SKILL.md +141 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/advanced-generics.md +90 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/branded-types.md +57 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/builder-pattern.md +71 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/common-pitfalls.md +135 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/conditional-types.md +27 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/decorators.md +98 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/discriminated-unions.md +62 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/mapped-types.md +53 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/performance-best-practices.md +104 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/template-literal-types.md +49 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/testing-types.md +112 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/type-guards.md +70 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/type-inference.md +101 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/utility-types.md +98 -0
- package/template/.codex/skill-library/stack/languages/vanilla-javascript/SKILL.md +803 -0
- package/template/.codex/skill-library/stack/messaging/kafka/SKILL.md +235 -0
- package/template/.codex/skill-library/stack/messaging/nats/SKILL.md +147 -0
- package/template/.codex/skill-library/stack/messaging/rabbitmq/SKILL.md +178 -0
- package/template/.codex/skill-library/stack/messaging/sqs/SKILL.md +187 -0
- package/template/.codex/skill-library/stack/mobile/expo-react-native/SKILL.md +665 -0
- package/template/.codex/skill-library/stack/mobile/flutter/SKILL.md +316 -0
- package/template/.codex/skill-library/stack/mobile/kotlin-compose/SKILL.md +215 -0
- package/template/.codex/skill-library/stack/mobile/react-native/SKILL.md +337 -0
- package/template/.codex/skill-library/stack/mobile/swiftui/SKILL.md +261 -0
- package/template/.codex/skill-library/stack/monitoring/posthog/SKILL.md +396 -0
- package/template/.codex/skill-library/stack/monitoring/sentry/SKILL.md +509 -0
- package/template/.codex/skill-library/stack/notifications/fcm/SKILL.md +229 -0
- package/template/.codex/skill-library/stack/notifications/sendgrid/SKILL.md +220 -0
- package/template/.codex/skill-library/stack/notifications/twilio/SKILL.md +204 -0
- package/template/.codex/skill-library/stack/observability/datadog/SKILL.md +179 -0
- package/template/.codex/skill-library/stack/observability/distributed-tracing/SKILL.md +140 -0
- package/template/.codex/skill-library/stack/observability/opentelemetry/SKILL.md +164 -0
- package/template/.codex/skill-library/stack/observability/prometheus-grafana/SKILL.md +246 -0
- package/template/.codex/skill-library/stack/observability/python-observability/SKILL.md +158 -0
- package/template/.codex/skill-library/stack/orm/drizzle-orm/SKILL.md +613 -0
- package/template/.codex/skill-library/stack/orm/prisma/SKILL.md +744 -0
- package/template/.codex/skill-library/stack/payments/lemonsqueezy/SKILL.md +393 -0
- package/template/.codex/skill-library/stack/payments/stripe-integration/SKILL.md +457 -0
- package/template/.codex/skill-library/stack/queue/bullmq/SKILL.md +385 -0
- package/template/.codex/skill-library/stack/queue/inngest/SKILL.md +438 -0
- package/template/.codex/skill-library/stack/realtime/socketio/SKILL.md +595 -0
- package/template/.codex/skill-library/stack/search/algolia/SKILL.md +206 -0
- package/template/.codex/skill-library/stack/search/elasticsearch/SKILL.md +248 -0
- package/template/.codex/skill-library/stack/search/meilisearch/SKILL.md +385 -0
- package/template/.codex/skill-library/stack/search/typesense/SKILL.md +189 -0
- package/template/.codex/skill-library/stack/security/crypto-patterns/SKILL.md +437 -0
- package/template/.codex/skill-library/stack/security/csp-cors-headers/SKILL.md +588 -0
- package/template/.codex/skill-library/stack/security/dependency-auditing/SKILL.md +560 -0
- package/template/.codex/skill-library/stack/security/input-sanitization/SKILL.md +430 -0
- package/template/.codex/skill-library/stack/security/owasp-web-security/SKILL.md +421 -0
- package/template/.codex/skill-library/stack/state/tanstack-query/SKILL.md +637 -0
- package/template/.codex/skill-library/stack/state/zustand/SKILL.md +483 -0
- package/template/.codex/skill-library/stack/storage/aws-s3/SKILL.md +415 -0
- package/template/.codex/skill-library/stack/storage/cloudflare-r2/SKILL.md +252 -0
- package/template/.codex/skill-library/stack/storage/gcs/SKILL.md +229 -0
- package/template/.codex/skill-library/stack/testing/playwright/SKILL.md +641 -0
- package/template/.codex/skill-library/stack/testing/storybook/SKILL.md +923 -0
- package/template/.codex/skill-library/stack/testing/testing-library/SKILL.md +872 -0
- package/template/.codex/skill-library/stack/testing/vitest/SKILL.md +714 -0
- package/template/.codex/skill-library/stack/ui/react-best-practices/SKILL.md +877 -0
- package/template/.codex/skill-library/stack/ui/react-composition-patterns/SKILL.md +1107 -0
- package/template/.codex/skill-library/stack/ui/react-flow/SKILL.md +425 -0
- package/template/.codex/skill-library/stack/ui/shadcn-ui/SKILL.md +703 -0
- package/template/.codex/skill-library/stack/ui/svelte-flow/SKILL.md +390 -0
- package/template/.codex/skill-library/surface/api/api-caching/SKILL.md +458 -0
- package/template/.codex/skill-library/surface/api/api-documentation-openapi/SKILL.md +697 -0
- package/template/.codex/skill-library/surface/api/api-error-handling/SKILL.md +478 -0
- package/template/.codex/skill-library/surface/api/api-security-checklist/SKILL.md +147 -0
- package/template/.codex/skill-library/surface/api/email-best-practices/SKILL.md +59 -0
- package/template/.codex/skill-library/surface/api/rate-limiting-abuse-protection/SKILL.md +147 -0
- package/template/.codex/skill-library/surface/api/webhook-design/SKILL.md +752 -0
- package/template/.codex/skill-library/surface/cli/cli-configuration-management/SKILL.md +445 -0
- package/template/.codex/skill-library/surface/cli/cli-error-diagnostics/SKILL.md +515 -0
- package/template/.codex/skill-library/surface/cli/cli-shell-integration/SKILL.md +479 -0
- package/template/.codex/skill-library/surface/cli/cli-ux-design/SKILL.md +477 -0
- package/template/.codex/skill-library/surface/desktop/desktop-app-distribution/SKILL.md +416 -0
- package/template/.codex/skill-library/surface/desktop/desktop-security-sandboxing/SKILL.md +407 -0
- package/template/.codex/skill-library/surface/desktop/desktop-ux-conventions/SKILL.md +361 -0
- package/template/.codex/skill-library/surface/desktop/native-os-integration/SKILL.md +563 -0
- package/template/.codex/skill-library/surface/extension/browser-extension-patterns/SKILL.md +482 -0
- package/template/.codex/skill-library/surface/extension/plugin-architecture-design/SKILL.md +632 -0
- package/template/.codex/skill-library/surface/extension/vscode-extension-development/SKILL.md +728 -0
- package/template/.codex/skill-library/surface/mobile/app-store-submission/SKILL.md +304 -0
- package/template/.codex/skill-library/surface/mobile/mobile-offline-sync/SKILL.md +443 -0
- package/template/.codex/skill-library/surface/mobile/mobile-responsive-patterns/SKILL.md +432 -0
- package/template/.codex/skill-library/surface/mobile/push-notifications/SKILL.md +495 -0
- package/template/.codex/skill-library/surface/web/accessibility-compliance/SKILL.md +827 -0
- package/template/.codex/skill-library/surface/web/ai-seo/SKILL.md +398 -0
- package/template/.codex/skill-library/surface/web/ai-seo/references/content-patterns.md +285 -0
- package/template/.codex/skill-library/surface/web/ai-seo/references/platform-ranking-factors.md +152 -0
- package/template/.codex/skill-library/surface/web/analytics-tracking/SKILL.md +309 -0
- package/template/.codex/skill-library/surface/web/analytics-tracking/references/event-library.md +260 -0
- package/template/.codex/skill-library/surface/web/analytics-tracking/references/ga4-implementation.md +300 -0
- package/template/.codex/skill-library/surface/web/analytics-tracking/references/gtm-implementation.md +390 -0
- package/template/.codex/skill-library/surface/web/authentication-ui-flows/SKILL.md +530 -0
- package/template/.codex/skill-library/surface/web/dark-mode-theming/SKILL.md +516 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/SKILL.md +105 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/charts.csv +26 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/colors.csv +97 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/landing.csv +31 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/styles.csv +59 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/typography.csv +58 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/ux-guidelines.csv +100 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/scripts/core.py +258 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/scripts/design_system.py +1067 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/scripts/search.py +106 -0
- package/template/.codex/skill-library/surface/web/form-handling-validation/SKILL.md +675 -0
- package/template/.codex/skill-library/surface/web/frontend-design/SKILL.md +1393 -0
- package/template/.codex/skill-library/surface/web/frontend-design/templates/cppn-hero.tsx +299 -0
- package/template/.codex/skill-library/surface/web/frontend-design/templates/wave-hero.tsx +875 -0
- package/template/.codex/skill-library/surface/web/frontend-verification/SKILL.md +111 -0
- package/template/.codex/skill-library/surface/web/frontend-verification/scripts/ux_audit.py +739 -0
- package/template/.codex/skill-library/surface/web/i18n-localization/SKILL.md +332 -0
- package/template/.codex/skill-library/surface/web/i18n-localization/references/icu-message-format.md +223 -0
- package/template/.codex/skill-library/surface/web/i18n-localization/references/intl-api-patterns.md +326 -0
- package/template/.codex/skill-library/surface/web/i18n-localization/references/rtl-support.md +298 -0
- package/template/.codex/skill-library/surface/web/offline-first-pwa/SKILL.md +657 -0
- package/template/.codex/skill-library/surface/web/page-cro/SKILL.md +182 -0
- package/template/.codex/skill-library/surface/web/page-cro/references/experiments.md +248 -0
- package/template/.codex/skill-library/surface/web/programmatic-seo/SKILL.md +238 -0
- package/template/.codex/skill-library/surface/web/programmatic-seo/references/playbooks.md +308 -0
- package/template/.codex/skill-library/surface/web/schema-markup/SKILL.md +179 -0
- package/template/.codex/skill-library/surface/web/schema-markup/references/schema-examples.md +398 -0
- package/template/.codex/skill-library/surface/web/seo-audit/SKILL.md +394 -0
- package/template/.codex/skill-library/surface/web/seo-audit/references/ai-writing-detection.md +200 -0
- package/template/.codex/skill-library/surface/web/web-performance-optimization/SKILL.md +646 -0
- package/template/.codex/skill-library/surface/web/web-scraping/SKILL.md +58 -0
- package/template/.codex/skills/README.md +78 -0
- package/template/.codex/skills/accessibility/SKILL.md +522 -0
- package/template/.codex/skills/accessibility/references/WCAG.md +162 -0
- package/template/.codex/skills/accessibility/references/ia-spec-checklist.md +35 -0
- package/template/.codex/skills/adversarial-review/SKILL.md +90 -0
- package/template/.codex/skills/antigravity-workflows/SKILL.md +81 -0
- package/template/.codex/skills/antigravity-workflows/resources/implementation-playbook.md +36 -0
- package/template/.codex/skills/api-design-principles/SKILL.md +169 -0
- package/template/.codex/skills/api-design-principles/assets/api-design-checklist.md +155 -0
- package/template/.codex/skills/api-design-principles/assets/rest-api-template.py +182 -0
- package/template/.codex/skills/api-design-principles/references/graphql-schema-design.md +583 -0
- package/template/.codex/skills/api-design-principles/references/rest-best-practices.md +408 -0
- package/template/.codex/skills/api-design-principles/resources/implementation-playbook.md +513 -0
- package/template/.codex/skills/api-versioning/SKILL.md +166 -0
- package/template/.codex/skills/api-versioning/references/typescript.md +157 -0
- package/template/.codex/skills/architecture-mapping/SKILL.md +219 -0
- package/template/.codex/skills/audit-ambiguity/SKILL.md +54 -0
- package/template/.codex/skills/audit-ambiguity-execute/SKILL.md +86 -0
- package/template/.codex/skills/audit-ambiguity-rubrics/SKILL.md +58 -0
- package/template/.codex/skills/bootstrap-agents/SKILL.md +258 -0
- package/template/.codex/skills/bootstrap-agents-fill/SKILL.md +25 -0
- package/template/.codex/skills/bootstrap-agents-provision/SKILL.md +22 -0
- package/template/.codex/skills/brainstorming/SKILL.md +177 -0
- package/template/.codex/skills/brand-guidelines/SKILL.md +44 -0
- package/template/.codex/skills/clean-code/SKILL.md +196 -0
- package/template/.codex/skills/clean-code/references/typescript.md +126 -0
- package/template/.codex/skills/code-review-pro/SKILL.md +152 -0
- package/template/.codex/skills/concise-planning/SKILL.md +107 -0
- package/template/.codex/skills/create-prd/SKILL.md +94 -0
- package/template/.codex/skills/create-prd-architecture/SKILL.md +72 -0
- package/template/.codex/skills/create-prd-compile/SKILL.md +85 -0
- package/template/.codex/skills/create-prd-design-system/SKILL.md +69 -0
- package/template/.codex/skills/create-prd-security/SKILL.md +66 -0
- package/template/.codex/skills/create-prd-stack/SKILL.md +84 -0
- package/template/.codex/skills/cross-layer-consistency/SKILL.md +117 -0
- package/template/.codex/skills/database-schema-design/SKILL.md +205 -0
- package/template/.codex/skills/database-schema-design/references/relational.md +228 -0
- package/template/.codex/skills/decompose-architecture/SKILL.md +72 -0
- package/template/.codex/skills/decompose-architecture-structure/SKILL.md +62 -0
- package/template/.codex/skills/decompose-architecture-validate/SKILL.md +72 -0
- package/template/.codex/skills/deployment-procedures/SKILL.md +241 -0
- package/template/.codex/skills/design-anti-cliche/SKILL.md +159 -0
- package/template/.codex/skills/design-direction/SKILL.md +45 -0
- package/template/.codex/skills/error-handling-patterns/SKILL.md +226 -0
- package/template/.codex/skills/error-handling-patterns/references/go.md +162 -0
- package/template/.codex/skills/error-handling-patterns/references/python.md +262 -0
- package/template/.codex/skills/error-handling-patterns/references/rust.md +112 -0
- package/template/.codex/skills/error-handling-patterns/references/typescript.md +178 -0
- package/template/.codex/skills/evolve-contract/SKILL.md +24 -0
- package/template/.codex/skills/evolve-feature/SKILL.md +18 -0
- package/template/.codex/skills/evolve-feature-cascade/SKILL.md +24 -0
- package/template/.codex/skills/evolve-feature-classify/SKILL.md +21 -0
- package/template/.codex/skills/find-skills/SKILL.md +145 -0
- package/template/.codex/skills/git-advanced/SKILL.md +972 -0
- package/template/.codex/skills/git-workflow/SKILL.md +420 -0
- package/template/.codex/skills/idea-extraction/SKILL.md +644 -0
- package/template/.codex/skills/ideate/SKILL.md +77 -0
- package/template/.codex/skills/ideate-discover/SKILL.md +89 -0
- package/template/.codex/skills/ideate-extract/SKILL.md +77 -0
- package/template/.codex/skills/ideate-validate/SKILL.md +75 -0
- package/template/.codex/skills/implement-slice/SKILL.md +64 -0
- package/template/.codex/skills/implement-slice-setup/SKILL.md +70 -0
- package/template/.codex/skills/implement-slice-tdd/SKILL.md +78 -0
- package/template/.codex/skills/logging-best-practices/SKILL.md +192 -0
- package/template/.codex/skills/logging-best-practices/references/go.md +49 -0
- package/template/.codex/skills/logging-best-practices/references/python.md +52 -0
- package/template/.codex/skills/logging-best-practices/references/typescript.md +215 -0
- package/template/.codex/skills/migration-management/SKILL.md +200 -0
- package/template/.codex/skills/migration-management/references/relational.md +214 -0
- package/template/.codex/skills/minimalist-surgical-development/SKILL.md +135 -0
- package/template/.codex/skills/parallel-agents/SKILL.md +165 -0
- package/template/.codex/skills/parallel-debugging/SKILL.md +135 -0
- package/template/.codex/skills/parallel-feature-development/SKILL.md +157 -0
- package/template/.codex/skills/performance-budgeting/SKILL.md +144 -0
- package/template/.codex/skills/pipeline-rubrics/SKILL.md +51 -0
- package/template/.codex/skills/pipeline-rubrics/references/architecture-rubric.md +19 -0
- package/template/.codex/skills/pipeline-rubrics/references/be-rubric.md +21 -0
- package/template/.codex/skills/pipeline-rubrics/references/fe-rubric.md +20 -0
- package/template/.codex/skills/pipeline-rubrics/references/ia-rubric.md +19 -0
- package/template/.codex/skills/pipeline-rubrics/references/scoring.md +32 -0
- package/template/.codex/skills/pipeline-rubrics/references/vision-rubric.md +12 -0
- package/template/.codex/skills/plan-phase/SKILL.md +62 -0
- package/template/.codex/skills/plan-phase-preflight/SKILL.md +75 -0
- package/template/.codex/skills/plan-phase-write/SKILL.md +85 -0
- package/template/.codex/skills/prd-templates/SKILL.md +107 -0
- package/template/.codex/skills/prd-templates/references/architecture-completeness-checklist.md +28 -0
- package/template/.codex/skills/prd-templates/references/architecture-design-template.md +88 -0
- package/template/.codex/skills/prd-templates/references/be-spec-classification.md +41 -0
- package/template/.codex/skills/prd-templates/references/be-spec-template.md +107 -0
- package/template/.codex/skills/prd-templates/references/bootstrap-verification-protocol.md +50 -0
- package/template/.codex/skills/prd-templates/references/constraint-exploration.md +41 -0
- package/template/.codex/skills/prd-templates/references/data-placement-template.md +74 -0
- package/template/.codex/skills/prd-templates/references/decision-confirmation-protocol.md +68 -0
- package/template/.codex/skills/prd-templates/references/decision-propagation.md +121 -0
- package/template/.codex/skills/prd-templates/references/decomposition-templates.md +226 -0
- package/template/.codex/skills/prd-templates/references/deep-ideation-loading-protocol.md +114 -0
- package/template/.codex/skills/prd-templates/references/design-system-decisions.md +198 -0
- package/template/.codex/skills/prd-templates/references/design-system-prerequisite-check.md +18 -0
- package/template/.codex/skills/prd-templates/references/domain-exhaustion-criteria.md +37 -0
- package/template/.codex/skills/prd-templates/references/engagement-tier-protocol.md +58 -0
- package/template/.codex/skills/prd-templates/references/engineering-standards-template.md +126 -0
- package/template/.codex/skills/prd-templates/references/evolution-layer-guidance.md +91 -0
- package/template/.codex/skills/prd-templates/references/expansion-modes.md +27 -0
- package/template/.codex/skills/prd-templates/references/fe-classification-procedures.md +47 -0
- package/template/.codex/skills/prd-templates/references/fe-spec-template.md +90 -0
- package/template/.codex/skills/prd-templates/references/feature-ledger-protocol.md +149 -0
- package/template/.codex/skills/prd-templates/references/folder-seeding-protocol.md +77 -0
- package/template/.codex/skills/prd-templates/references/fractal-cx-template.md +58 -0
- package/template/.codex/skills/prd-templates/references/fractal-feature-template.md +93 -0
- package/template/.codex/skills/prd-templates/references/fractal-node-index-template.md +55 -0
- package/template/.codex/skills/prd-templates/references/gate-applicability.md +92 -0
- package/template/.codex/skills/prd-templates/references/ideation-crosscut-template.md +36 -0
- package/template/.codex/skills/prd-templates/references/ideation-index-template.md +111 -0
- package/template/.codex/skills/prd-templates/references/ideation-meta-template.md +126 -0
- package/template/.codex/skills/prd-templates/references/infrastructure-report-template.md +71 -0
- package/template/.codex/skills/prd-templates/references/input-classification.md +23 -0
- package/template/.codex/skills/prd-templates/references/map-guard-protocol.md +65 -0
- package/template/.codex/skills/prd-templates/references/operational-templates.md +116 -0
- package/template/.codex/skills/prd-templates/references/persona-completeness-gate.md +20 -0
- package/template/.codex/skills/prd-templates/references/placeholder-guard-template.md +21 -0
- package/template/.codex/skills/prd-templates/references/placeholder-workflow-mapping.md +50 -0
- package/template/.codex/skills/prd-templates/references/shard-boundary-analysis.md +103 -0
- package/template/.codex/skills/prd-templates/references/shard-split-remediation.md +157 -0
- package/template/.codex/skills/prd-templates/references/skill-loading-protocol.md +36 -0
- package/template/.codex/skills/prd-templates/references/slice-completion-gates.md +29 -0
- package/template/.codex/skills/prd-templates/references/spec-coverage-sweep.md +44 -0
- package/template/.codex/skills/prd-templates/references/surface-model.md +61 -0
- package/template/.codex/skills/prd-templates/references/tdd-testing-policy.md +39 -0
- package/template/.codex/skills/prd-templates/references/vision-template.md +57 -0
- package/template/.codex/skills/prd-templates/references/workflow-checkpoint-protocol.md +112 -0
- package/template/.codex/skills/prd-templates/references/write-verification-protocol.md +57 -0
- package/template/.codex/skills/prompt-engineer/SKILL.md +203 -0
- package/template/.codex/skills/propagate-decision/SKILL.md +18 -0
- package/template/.codex/skills/propagate-decision-apply/SKILL.md +22 -0
- package/template/.codex/skills/propagate-decision-scan/SKILL.md +20 -0
- package/template/.codex/skills/regex-patterns/SKILL.md +333 -0
- package/template/.codex/skills/regex-patterns/references/go.md +44 -0
- package/template/.codex/skills/regex-patterns/references/javascript.md +63 -0
- package/template/.codex/skills/regex-patterns/references/python.md +77 -0
- package/template/.codex/skills/regex-patterns/references/rust.md +43 -0
- package/template/.codex/skills/remediate-pipeline/SKILL.md +18 -0
- package/template/.codex/skills/remediate-pipeline-assess/SKILL.md +21 -0
- package/template/.codex/skills/remediate-pipeline-execute/SKILL.md +23 -0
- package/template/.codex/skills/remediate-shard-split/SKILL.md +21 -0
- package/template/.codex/skills/resolve-ambiguity/SKILL.md +278 -0
- package/template/.codex/skills/security-scanning-security-hardening/SKILL.md +231 -0
- package/template/.codex/skills/session-continuity/SKILL.md +732 -0
- package/template/.codex/skills/session-continuity/protocols/01-session-resumption.md +38 -0
- package/template/.codex/skills/session-continuity/protocols/02-progress-generation.md +85 -0
- package/template/.codex/skills/session-continuity/protocols/03-progress-update.md +70 -0
- package/template/.codex/skills/session-continuity/protocols/04-pattern-extraction.md +60 -0
- package/template/.codex/skills/session-continuity/protocols/05-session-close.md +37 -0
- package/template/.codex/skills/session-continuity/protocols/06-decision-analysis.md +84 -0
- package/template/.codex/skills/session-continuity/protocols/07-spec-pipeline-generation.md +48 -0
- package/template/.codex/skills/session-continuity/protocols/08-spec-pipeline-update.md +65 -0
- package/template/.codex/skills/session-continuity/protocols/09-parallel-claim.md +122 -0
- package/template/.codex/skills/session-continuity/protocols/10-placeholder-verification-gate.md +83 -0
- package/template/.codex/skills/session-continuity/protocols/11-parallel-synthesis.md +21 -0
- package/template/.codex/skills/session-continuity/protocols/ambiguity-gates.md +48 -0
- package/template/.codex/skills/setup/README.md +24 -0
- package/template/.codex/skills/setup/setup-cfsa.md +200 -0
- package/template/.codex/skills/setup/setup-fill-placeholders.md +192 -0
- package/template/.codex/skills/setup/setup-provision-skills.md +82 -0
- package/template/.codex/skills/setup/setup-verify.md +89 -0
- package/template/.codex/skills/setup-workspace/SKILL.md +83 -0
- package/template/.codex/skills/setup-workspace-cicd/SKILL.md +56 -0
- package/template/.codex/skills/setup-workspace-data/SKILL.md +69 -0
- package/template/.codex/skills/setup-workspace-hosting/SKILL.md +59 -0
- package/template/.codex/skills/setup-workspace-scaffold/SKILL.md +72 -0
- package/template/.codex/skills/skill-creator/SKILL.md +203 -0
- package/template/.codex/skills/spec-writing/SKILL.md +110 -0
- package/template/.codex/skills/sync-kit/SKILL.md +23 -0
- package/template/.codex/skills/systematic-debugging/CREATION-LOG.md +119 -0
- package/template/.codex/skills/systematic-debugging/SKILL.md +297 -0
- package/template/.codex/skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
- package/template/.codex/skills/systematic-debugging/condition-based-waiting.md +115 -0
- package/template/.codex/skills/systematic-debugging/defense-in-depth.md +122 -0
- package/template/.codex/skills/systematic-debugging/find-polluter.sh +63 -0
- package/template/.codex/skills/systematic-debugging/root-cause-tracing.md +169 -0
- package/template/.codex/skills/systematic-debugging/test-academic.md +14 -0
- package/template/.codex/skills/systematic-debugging/test-pressure-1.md +58 -0
- package/template/.codex/skills/systematic-debugging/test-pressure-2.md +68 -0
- package/template/.codex/skills/systematic-debugging/test-pressure-3.md +69 -0
- package/template/.codex/skills/tdd-workflow/SKILL.md +186 -0
- package/template/.codex/skills/tdd-workflow/references/typescript.md +231 -0
- package/template/.codex/skills/tech-stack-catalog/SKILL.md +49 -0
- package/template/.codex/skills/tech-stack-catalog/references/constraint-questions.md +237 -0
- package/template/.codex/skills/tech-stack-catalog/references/dev-tooling-decisions.md +37 -0
- package/template/.codex/skills/tech-stack-catalog/references/surface-decision-tables.md +69 -0
- package/template/.codex/skills/technical-writer/SKILL.md +242 -0
- package/template/.codex/skills/testing-strategist/SKILL.md +319 -0
- package/template/.codex/skills/testing-strategist/references/typescript.md +328 -0
- package/template/.codex/skills/update-architecture-map/SKILL.md +21 -0
- package/template/.codex/skills/utilities/resolve-skill.md +195 -0
- package/template/.codex/skills/validate-phase/SKILL.md +62 -0
- package/template/.codex/skills/validate-phase-quality/SKILL.md +67 -0
- package/template/.codex/skills/validate-phase-readiness/SKILL.md +74 -0
- package/template/.codex/skills/verification-before-completion/SKILL.md +97 -0
- package/template/.codex/skills/verify-infrastructure/SKILL.md +25 -0
- package/template/.codex/skills/workflow-automation/SKILL.md +166 -0
- package/template/.codex/skills/workflow-automation/references/inngest.md +88 -0
- package/template/.codex/skills/workflow-automation/references/temporal.md +64 -0
- package/template/.codex/skills/write-architecture-spec/SKILL.md +78 -0
- package/template/.codex/skills/write-architecture-spec-deepen/SKILL.md +82 -0
- package/template/.codex/skills/write-architecture-spec-design/SKILL.md +80 -0
- package/template/.codex/skills/write-be-spec/SKILL.md +75 -0
- package/template/.codex/skills/write-be-spec-classify/SKILL.md +80 -0
- package/template/.codex/skills/write-be-spec-write/SKILL.md +99 -0
- package/template/.codex/skills/write-fe-spec/SKILL.md +79 -0
- package/template/.codex/skills/write-fe-spec-classify/SKILL.md +77 -0
- package/template/.codex/skills/write-fe-spec-write/SKILL.md +88 -0
- package/template/.factory/README.md +2 -3
- package/template/.factory/instructions/workflow.md +3 -3
- package/template/.factory/kit-sync.md +3 -3
- package/template/.factory/skills/completion-checklist/SKILL.md +3 -3
- package/template/.factory/skills/parallel-agents/SKILL.md +1 -1
- package/template/.factory/skills/plan-phase/SKILL.md +2 -2
- package/template/.factory/skills/plan-phase-preflight/SKILL.md +2 -2
- package/template/.factory/skills/session-continuity/SKILL.md +6 -6
- package/template/.factory/skills/session-continuity/protocols/01-session-resumption.md +1 -1
- package/template/.factory/skills/session-continuity/protocols/02-progress-generation.md +3 -3
- package/template/.factory/skills/session-continuity/protocols/03-progress-update.md +4 -4
- package/template/.factory/skills/session-continuity/protocols/07-spec-pipeline-generation.md +1 -1
- package/template/.factory/skills/session-continuity/protocols/08-spec-pipeline-update.md +2 -2
- package/template/.factory/skills/session-continuity/protocols/11-parallel-synthesis.md +1 -1
- package/template/.factory/skills/setup-cfsa/SKILL.md +1 -1
- package/template/.factory/skills/write-architecture-spec/SKILL.md +2 -2
- package/template/.factory/skills/write-architecture-spec-deepen/SKILL.md +1 -1
- package/template/.factory/skills/write-architecture-spec-design/SKILL.md +1 -1
- package/template/.factory/skills/write-be-spec/SKILL.md +3 -3
- package/template/.factory/skills/write-be-spec-classify/SKILL.md +1 -1
- package/template/.factory/skills/write-be-spec-write/SKILL.md +1 -1
- package/template/.factory/skills/write-fe-spec/SKILL.md +3 -3
- package/template/.factory/skills/write-fe-spec-write/SKILL.md +1 -1
- package/template/.memory/README.md +1 -0
- package/template/.memory/mcp-server/README.md +10 -2
- package/template/.memory/mcp-server/client.mjs +61 -18
- package/template/.memory/mcp-server/daemon.mjs +8 -3
- package/template/.memory/mcp-server/runtime.mjs +51 -14
- package/template/.memory/mcp-server/start.mjs +4 -2
- package/template/.memory/migrate/migrate-legacy.mjs +1 -0
- package/template/.memory/pipeline/README.md +1 -0
- package/template/CLAUDE.md +4 -4
- package/template/CODEX.md +6 -53
- package/template/GEMINI.md +2 -2
- package/template/docs/README.md +5 -2
- package/template/docs/kit-architecture.md +36 -19
- package/template/docs/progress-state-catalog.md +48 -0
- package/template/.factory/progress/memory/.gitkeep +0 -0
- /package/template/{.agent/progress → .codex/skills/skill-creator/references}/.gitkeep +0 -0
- /package/template/{.agent/progress/memory → .codex/skills/skill-creator/scripts}/.gitkeep +0 -0
- /package/template/{.agent/progress/sessions → .memory/pipeline/progress}/.gitkeep +0 -0
- /package/template/{.claude/progress → .memory/pipeline/progress/memory}/.gitkeep +0 -0
- /package/template/{.claude/progress/memory → .memory/pipeline/progress/phases}/.gitkeep +0 -0
- /package/template/{.claude → .memory/pipeline}/progress/sessions/.gitkeep +0 -0
- /package/template/{.factory/progress → .memory/pipeline/progress/slices}/.gitkeep +0 -0
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
# Constraint Questions
|
|
2
|
+
|
|
3
|
+
Per-axis constraint questions with mandatory ideation grounding. Every axis has two tiers of questions and a citation gate.
|
|
4
|
+
|
|
5
|
+
## How to Use This File
|
|
6
|
+
|
|
7
|
+
For **each** tech stack axis:
|
|
8
|
+
|
|
9
|
+
1. **Tier 1 — Self-answer from ideation**: Answer these questions by reading the ideation files listed in the **Required Reads** column. Do NOT ask the user these questions — you already have the answers in the ideation output. Write a 3-5 bullet **Ideation Synthesis** summarizing what you found.
|
|
10
|
+
2. **Cite-or-Stop Gate**: Your Ideation Synthesis must contain ≥ 2 project-specific findings with file citations (e.g., "From `diagnostics/diagnostics-index.md`: multi-agent orchestration requires persistent task queues"). If you cannot produce 2 citations → you have not read deeply enough → **STOP** and read the deep dives and CX files before continuing.
|
|
11
|
+
3. **Tier 2 — Ask the user**: Only after passing the citation gate, ask these questions to the user. These are things only the user can answer (budget, team expertise, preferences).
|
|
12
|
+
4. **Present options**: Combine ideation synthesis + user answers to filter and score options. Your recommendation MUST cite ideation findings as supporting evidence.
|
|
13
|
+
|
|
14
|
+
> ❌ **Anti-pattern**: Presenting generic strengths/risks like "Good ecosystem support" or "Scalable" without tying them to a specific ideation finding. Every strength/risk in the option table must reference a concrete project requirement from the ideation output.
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Hosting
|
|
19
|
+
|
|
20
|
+
### Required Reads
|
|
21
|
+
|
|
22
|
+
| File Pattern | What to Extract |
|
|
23
|
+
|---|---|
|
|
24
|
+
| `meta/constraints.md` → `## Project Surfaces` | Which surfaces need hosting (web, API, desktop distribution, mobile distribution) |
|
|
25
|
+
| `meta/constraints.md` → compliance section | Data residency, regulatory requirements that constrain hosting region/provider |
|
|
26
|
+
| Every domain `{domain}-index.md` | Features requiring edge compute, real-time, WebSocket, or heavy compute |
|
|
27
|
+
| CX files (`ideation-cx.md` + domain CX) | Cross-surface data flow that affects deployment topology |
|
|
28
|
+
| Deep dives with latency or performance mentions | P95 requirements, geographic distribution needs |
|
|
29
|
+
|
|
30
|
+
### Tier 1 — Self-answer from ideation
|
|
31
|
+
|
|
32
|
+
- What surfaces need hosting and what type of hosting each requires (static, SSR, API, worker)?
|
|
33
|
+
- Are there latency-sensitive features that require edge deployment?
|
|
34
|
+
- Are there compliance or data residency constraints that limit hosting geography?
|
|
35
|
+
- Do any features require persistent connections (WebSocket, SSE) that affect hosting choice?
|
|
36
|
+
- What is the deployment topology implied by the architecture (monolith, microservices, serverless)?
|
|
37
|
+
|
|
38
|
+
### Tier 2 — Ask the user
|
|
39
|
+
|
|
40
|
+
- Is there an existing cloud provider or hosting preference?
|
|
41
|
+
- What is the monthly hosting budget ceiling?
|
|
42
|
+
- How much operational complexity is acceptable (managed vs self-hosted)?
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Database / Persistence
|
|
47
|
+
|
|
48
|
+
### Required Reads
|
|
49
|
+
|
|
50
|
+
| File Pattern | What to Extract |
|
|
51
|
+
|---|---|
|
|
52
|
+
| Every domain `{domain}-index.md` | Entity types, relationship complexity, data cardinality |
|
|
53
|
+
| Deep dives with data model mentions | Graph relationships, hierarchical data, polymorphic entities |
|
|
54
|
+
| Deep dives with search/query mentions | Full-text search, faceted search, complex query patterns |
|
|
55
|
+
| Deep dives with sync/real-time mentions | Offline-first, CRDT, conflict resolution, real-time subscriptions |
|
|
56
|
+
| CX files | Cross-domain entity ownership, shared entities, data flow direction |
|
|
57
|
+
| `meta/constraints.md` | PII fields, compliance (HIPAA/PCI/GDPR) affecting data placement |
|
|
58
|
+
|
|
59
|
+
### Tier 1 — Self-answer from ideation
|
|
60
|
+
|
|
61
|
+
- What are the primary entity types and their relationships (flat, hierarchical, graph)?
|
|
62
|
+
- Are there features requiring graph traversal (e.g., dependency chains, social connections, multi-hop queries)?
|
|
63
|
+
- Are there features requiring full-text search, vector similarity, or faceted filtering?
|
|
64
|
+
- What are the read/write patterns implied by the feature workflows (read-heavy dashboards, write-heavy logging, balanced CRUD)?
|
|
65
|
+
- Are there real-time or offline-first requirements that affect database choice?
|
|
66
|
+
- Do any entities require time-series storage (metrics, audit logs, sensor data)?
|
|
67
|
+
- What PII fields exist and what isolation boundaries are required?
|
|
68
|
+
|
|
69
|
+
### Tier 2 — Ask the user
|
|
70
|
+
|
|
71
|
+
- Is there existing database expertise or infrastructure to leverage?
|
|
72
|
+
- Are there multi-tenancy requirements the ideation didn't capture?
|
|
73
|
+
- Budget constraints for managed database services?
|
|
74
|
+
|
|
75
|
+
> **Note**: Database is handled by the Persistence Map Interview in `create-prd-stack.md`. These questions feed into that interview — they do not replace it.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Auth Provider
|
|
80
|
+
|
|
81
|
+
### Required Reads
|
|
82
|
+
|
|
83
|
+
| File Pattern | What to Extract |
|
|
84
|
+
|---|---|
|
|
85
|
+
| Every domain `{domain}-index.md` → Role Matrix | All roles, permission levels (Full/Config/Read-only/None), per-domain access |
|
|
86
|
+
| `meta/constraints.md` → compliance section | COPPA, GDPR, age restrictions, SSO requirements |
|
|
87
|
+
| Domain deep dives with access control mentions | Multi-tenant isolation, resource ownership, escalation paths |
|
|
88
|
+
| CX files | Trust boundaries across domains, cross-domain permission handoff |
|
|
89
|
+
|
|
90
|
+
### Tier 1 — Self-answer from ideation
|
|
91
|
+
|
|
92
|
+
- How many distinct roles exist and what are their permission boundaries?
|
|
93
|
+
- Is there a multi-tenant model (org-level isolation, workspace-level, etc.)?
|
|
94
|
+
- Are there age restrictions or minor-handling requirements (COPPA)?
|
|
95
|
+
- Do any features require granular resource-level permissions (ABAC) vs role-based (RBAC)?
|
|
96
|
+
- Are there third-party integration points that need OAuth/API key authentication?
|
|
97
|
+
- Does the app need social login, SSO/SAML, or enterprise federation?
|
|
98
|
+
|
|
99
|
+
### Tier 2 — Ask the user
|
|
100
|
+
|
|
101
|
+
- Is social login (Google, GitHub, Apple, etc.) required? Which providers?
|
|
102
|
+
- Is SSO/SAML needed for enterprise customers?
|
|
103
|
+
- Budget for auth provider (free tier vs paid)?
|
|
104
|
+
- Team experience with specific auth providers?
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## Frontend Framework
|
|
109
|
+
|
|
110
|
+
### Required Reads
|
|
111
|
+
|
|
112
|
+
| File Pattern | What to Extract |
|
|
113
|
+
|---|---|
|
|
114
|
+
| `meta/constraints.md` → `## Project Surfaces` | Web surface type (app, content site, hybrid), SEO requirements |
|
|
115
|
+
| Every domain `{domain}-index.md` | UI complexity per domain — forms, dashboards, real-time views, interactive editors |
|
|
116
|
+
| Deep dives with UI/interaction mentions | Complex interaction patterns (drag-drop, canvas, WYSIWYG, collaborative editing) |
|
|
117
|
+
| Deep dives with real-time mentions | Live updates, WebSocket-driven UI, optimistic updates |
|
|
118
|
+
| CX files | Cross-domain navigation patterns, shared UI state requirements |
|
|
119
|
+
|
|
120
|
+
### Tier 1 — Self-answer from ideation
|
|
121
|
+
|
|
122
|
+
- Is SSR required for SEO or first-paint performance, or is this a pure SPA?
|
|
123
|
+
- How complex are the interactive patterns (simple forms vs complex editors vs canvas-based)?
|
|
124
|
+
- Are there real-time UI requirements (live dashboards, collaborative editing)?
|
|
125
|
+
- What is the page count / route complexity implied by the feature inventory?
|
|
126
|
+
- Are there offline-first or PWA requirements that affect framework choice?
|
|
127
|
+
- Does the app need to share code with other surfaces (mobile, desktop)?
|
|
128
|
+
|
|
129
|
+
### Tier 2 — Ask the user
|
|
130
|
+
|
|
131
|
+
- Team framework experience or preference?
|
|
132
|
+
- Is there an existing frontend codebase to integrate with?
|
|
133
|
+
- Performance priority: bundle size vs DX vs ecosystem maturity?
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## Backend Framework / Runtime
|
|
138
|
+
|
|
139
|
+
### Required Reads
|
|
140
|
+
|
|
141
|
+
| File Pattern | What to Extract |
|
|
142
|
+
|---|---|
|
|
143
|
+
| `meta/constraints.md` → `## Project Surfaces` | Backend surface type (API-only, BFF, monolith) |
|
|
144
|
+
| Every domain `{domain}-index.md` | Feature complexity — CRUD-heavy vs computation-heavy vs orchestration-heavy |
|
|
145
|
+
| Deep dives with AI/ML mentions | AI orchestration, model serving, agent coordination |
|
|
146
|
+
| Deep dives with integration mentions | External API calls, webhook handling, queue processing |
|
|
147
|
+
| CX files | Cross-domain business logic, shared middleware requirements |
|
|
148
|
+
|
|
149
|
+
### Tier 1 — Self-answer from ideation
|
|
150
|
+
|
|
151
|
+
- What type of backend logic dominates — simple CRUD, complex business rules, AI orchestration, or data pipelines?
|
|
152
|
+
- Are there features requiring long-running processes (agents, batch jobs, async workflows)?
|
|
153
|
+
- What are the latency requirements (P95 targets from deep dives)?
|
|
154
|
+
- Is there a need for background job processing or event-driven architecture?
|
|
155
|
+
- Does the backend need to serve multiple surfaces with different protocols (REST for web, gRPC for internal)?
|
|
156
|
+
- Are there cold-start sensitivity constraints (serverless viability)?
|
|
157
|
+
|
|
158
|
+
### Tier 2 — Ask the user
|
|
159
|
+
|
|
160
|
+
- Team language/framework expertise?
|
|
161
|
+
- Deployment target preference (traditional server, serverless, edge)?
|
|
162
|
+
- Is there an existing backend to extend vs greenfield?
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## API Layer
|
|
167
|
+
|
|
168
|
+
### Required Reads
|
|
169
|
+
|
|
170
|
+
| File Pattern | What to Extract |
|
|
171
|
+
|---|---|
|
|
172
|
+
| Every domain `{domain}-index.md` | Query complexity per domain — simple lookups vs complex filtered/nested queries |
|
|
173
|
+
| Deep dives with data fetching mentions | Over-fetching risks, real-time subscription needs, batch query patterns |
|
|
174
|
+
| CX files | Cross-domain data aggregation, BFF patterns, gateway needs |
|
|
175
|
+
| `meta/constraints.md` → `## Project Surfaces` | Number of consuming surfaces (affects API style choice) |
|
|
176
|
+
|
|
177
|
+
### Tier 1 — Self-answer from ideation
|
|
178
|
+
|
|
179
|
+
- How varied are the data fetching patterns (uniform CRUD vs highly variable query shapes)?
|
|
180
|
+
- Are there features requiring real-time subscriptions?
|
|
181
|
+
- How many surfaces consume the API (affects REST vs GraphQL vs tRPC calculus)?
|
|
182
|
+
- Is there a need for API-to-API communication (microservice internal APIs)?
|
|
183
|
+
- Are there complex nested data requirements that would benefit from flexible query languages?
|
|
184
|
+
|
|
185
|
+
### Tier 2 — Ask the user
|
|
186
|
+
|
|
187
|
+
- Is the API public-facing (needs REST + OpenAPI) or internal-only (tRPC viable)?
|
|
188
|
+
- Team experience with GraphQL vs REST vs tRPC?
|
|
189
|
+
- Is API versioning a concern (breaking change frequency)?
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## CI/CD
|
|
194
|
+
|
|
195
|
+
### Required Reads
|
|
196
|
+
|
|
197
|
+
| File Pattern | What to Extract |
|
|
198
|
+
|---|---|
|
|
199
|
+
| `meta/constraints.md` → `## Project Surfaces` | Number of deployable surfaces (affects pipeline complexity) |
|
|
200
|
+
| `meta/constraints.md` → compliance section | Audit requirements, approval gates, compliance-mandated scanning |
|
|
201
|
+
|
|
202
|
+
### Tier 1 — Self-answer from ideation
|
|
203
|
+
|
|
204
|
+
- How many independently deployable artifacts exist?
|
|
205
|
+
- Are there compliance requirements mandating specific CI/CD gates (security scanning, approval workflows)?
|
|
206
|
+
- Is the project monorepo or polyrepo (affects CI/CD tooling)?
|
|
207
|
+
|
|
208
|
+
### Tier 2 — Ask the user
|
|
209
|
+
|
|
210
|
+
- Is there an existing CI/CD provider?
|
|
211
|
+
- Deployment frequency expectations (continuous vs scheduled)?
|
|
212
|
+
- Are manual approval gates needed for production deploys?
|
|
213
|
+
|
|
214
|
+
---
|
|
215
|
+
|
|
216
|
+
## Monitoring / Observability
|
|
217
|
+
|
|
218
|
+
### Required Reads
|
|
219
|
+
|
|
220
|
+
| File Pattern | What to Extract |
|
|
221
|
+
|---|---|
|
|
222
|
+
| Deep dives with performance/SLA mentions | Which features have SLA requirements driving alert thresholds |
|
|
223
|
+
| `meta/constraints.md` → compliance section | Audit logging requirements, log retention mandates |
|
|
224
|
+
| Every domain `{domain}-index.md` | Features with error-sensitive flows (payments, auth, data sync) |
|
|
225
|
+
|
|
226
|
+
### Tier 1 — Self-answer from ideation
|
|
227
|
+
|
|
228
|
+
- Which features are error-critical (payment flows, auth, data integrity)?
|
|
229
|
+
- Are there SLA or uptime requirements from the ideation?
|
|
230
|
+
- What audit logging is mandated by compliance?
|
|
231
|
+
- Are there features requiring distributed tracing (multi-service request paths)?
|
|
232
|
+
|
|
233
|
+
### Tier 2 — Ask the user
|
|
234
|
+
|
|
235
|
+
- Is there an existing monitoring stack?
|
|
236
|
+
- Budget for monitoring services?
|
|
237
|
+
- On-call expectations (who gets alerted)?
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Development Tooling Decisions
|
|
2
|
+
|
|
3
|
+
## Tooling axes
|
|
4
|
+
|
|
5
|
+
| Tool | Question |
|
|
6
|
+
|------|----------|
|
|
7
|
+
| **Package manager / build system** | pnpm, npm, yarn, bun, cargo, go modules, pip/poetry? |
|
|
8
|
+
| **Test runner** | Vitest, Jest, pytest, cargo test, go test, XCTest? |
|
|
9
|
+
| **Linter** | ESLint, Biome, Ruff, clippy, golangci-lint? |
|
|
10
|
+
| **Type checker** | TypeScript (tsc), mypy, Rust compiler, Go compiler? |
|
|
11
|
+
| **Build command** | What builds the project for production? |
|
|
12
|
+
|
|
13
|
+
## Bootstrap keys to fire after confirmation
|
|
14
|
+
|
|
15
|
+
After the user confirms all development tooling, fire bootstrap with `PIPELINE_STAGE=create-prd` and ALL of these keys:
|
|
16
|
+
|
|
17
|
+
- `PACKAGE_MANAGER` — the confirmed package manager (e.g., `pnpm`)
|
|
18
|
+
- `TEST_RUNNER` — the confirmed test runner (e.g., `vitest`)
|
|
19
|
+
- `LINTER` — the confirmed linter (e.g., `eslint`)
|
|
20
|
+
- `TYPE_CHECKER` — the confirmed type checker (e.g., `tsc`)
|
|
21
|
+
- `TEST_COMMAND` — derived from package manager + test runner (e.g., `pnpm test`)
|
|
22
|
+
- `TEST_WATCH_COMMAND` — derived test watch command (e.g., `pnpm test:watch`)
|
|
23
|
+
- `TEST_COVERAGE_COMMAND` — derived coverage command (e.g., `pnpm test:coverage`)
|
|
24
|
+
- `LINT_COMMAND` — derived lint command (e.g., `pnpm lint`)
|
|
25
|
+
- `LINT_FIX_COMMAND` — derived lint fix command (e.g., `pnpm lint:fix`)
|
|
26
|
+
- `FORMAT_COMMAND` — derived format command (e.g., `pnpm format`)
|
|
27
|
+
- `TYPE_CHECK_COMMAND` — derived type-check command (e.g., `pnpm type-check`)
|
|
28
|
+
- `BUILD_COMMAND` — derived build command (e.g., `pnpm build`)
|
|
29
|
+
- `VALIDATION_COMMAND` — the full validation pipeline (e.g., `pnpm test && pnpm lint && pnpm type-check && pnpm build`)
|
|
30
|
+
|
|
31
|
+
This fills command placeholders in `commands.md`, `workflow.md`, `implement-slice-tdd.md`, and `validate-phase.md`.
|
|
32
|
+
|
|
33
|
+
## Validation command derivation
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
{{BUILD_TOOL}} test && {{BUILD_TOOL}} lint && {{BUILD_TOOL}} type-check && {{BUILD_TOOL}} build
|
|
37
|
+
```
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# Surface Decision Tables
|
|
2
|
+
|
|
3
|
+
## Universal decisions (all project types)
|
|
4
|
+
|
|
5
|
+
| Axis | Decision Needed |
|
|
6
|
+
|------|----------------|
|
|
7
|
+
| **Primary language(s)** | TypeScript, Rust, Go, Python, Swift, Kotlin, C++, etc. |
|
|
8
|
+
| **Database** | ⚠️ **Handled by Persistence Map Interview** in `create-prd-stack.md` — do NOT process as a single axis. Covers primary, vector, graph, cache, and time-series sub-keys. |
|
|
9
|
+
| **Auth provider** | Firebase vs Auth0 vs Clerk vs custom vs OS-level keychain |
|
|
10
|
+
| **CI/CD** | GitHub Actions vs GitLab CI vs custom |
|
|
11
|
+
| **Monitoring** | Sentry vs Datadog vs custom |
|
|
12
|
+
|
|
13
|
+
## Web surface decisions
|
|
14
|
+
|
|
15
|
+
| Axis | Decision Needed |
|
|
16
|
+
|------|----------------|
|
|
17
|
+
| **Frontend framework** | SSR vs SSG vs hybrid, which framework (Next.js, Astro, SvelteKit, etc.) |
|
|
18
|
+
| **Backend runtime** | Edge workers vs traditional server vs serverless |
|
|
19
|
+
| **Hosting** | Cloudflare vs Vercel vs AWS vs self-hosted |
|
|
20
|
+
| **CDN/Assets** | Provider-native vs S3 vs Cloudinary |
|
|
21
|
+
|
|
22
|
+
## Desktop surface decisions
|
|
23
|
+
|
|
24
|
+
| Axis | Decision Needed |
|
|
25
|
+
|------|----------------|
|
|
26
|
+
| **UI framework** | Tauri vs Electron vs native (GTK, Qt, SwiftUI, WPF, WinUI) |
|
|
27
|
+
| **Cross-platform strategy** | Single OS, cross-platform with shared UI (Tauri, Electron, Flutter Desktop), or cross-platform with native UI per OS |
|
|
28
|
+
| **Local data storage** | SQLite vs LevelDB vs filesystem vs embedded DB (RocksDB, etc.) |
|
|
29
|
+
| **Distribution** | Installer type (MSI, DMG, AppImage, Flatpak), auto-updater strategy (Sparkle, squirrel, custom) |
|
|
30
|
+
| **OS targets** | Windows, macOS, Linux — which combinations and minimum versions? |
|
|
31
|
+
|
|
32
|
+
## Mobile surface decisions
|
|
33
|
+
|
|
34
|
+
| Axis | Decision Needed |
|
|
35
|
+
|------|----------------|
|
|
36
|
+
| **Framework** | Native per-platform (Swift/Kotlin) vs cross-platform (React Native, Flutter, .NET MAUI, Kotlin Multiplatform) |
|
|
37
|
+
| **Cross-platform strategy** | iOS-only, Android-only, or both? Shared codebase or separate? |
|
|
38
|
+
| **Local data storage** | SQLite, Realm, Core Data, Room |
|
|
39
|
+
| **Distribution** | App Store, Play Store, enterprise sideload, TestFlight/Firebase App Distribution |
|
|
40
|
+
| **OS targets** | iOS minimum version, Android minimum API level |
|
|
41
|
+
|
|
42
|
+
## Desktop + Mobile shared decisions
|
|
43
|
+
|
|
44
|
+
Some frameworks support building for **both** desktop and mobile from one codebase. If the vision indicates this is desired:
|
|
45
|
+
|
|
46
|
+
| Axis | Decision Needed |
|
|
47
|
+
|------|----------------|
|
|
48
|
+
| **Shared framework** | Flutter (desktop + mobile + web), Kotlin Multiplatform, .NET MAUI, Compose Multiplatform |
|
|
49
|
+
| **Shared vs platform-specific UI** | Fully shared UI, shared logic with native UI per platform, or hybrid? |
|
|
50
|
+
| **Platform-specific features** | What functionality requires native code per platform? (file system, notifications, hardware access) |
|
|
51
|
+
|
|
52
|
+
## CLI surface decisions
|
|
53
|
+
|
|
54
|
+
| Axis | Decision Needed |
|
|
55
|
+
|------|----------------|
|
|
56
|
+
| **Language** | Rust (clap), Go (cobra), Python (click/typer), Node (commander/yargs) |
|
|
57
|
+
| **Distribution** | npm, cargo, homebrew, apt, binary releases (goreleaser, cross) |
|
|
58
|
+
| **Shell integration** | Tab completions, man pages, config file format (TOML, YAML, JSON) |
|
|
59
|
+
|
|
60
|
+
## Multi-surface connection decisions (2+ connected surfaces)
|
|
61
|
+
|
|
62
|
+
| Axis | Decision Needed |
|
|
63
|
+
|------|----------------|
|
|
64
|
+
| **Shared API protocol** | REST vs gRPC vs GraphQL vs WebSocket between surfaces |
|
|
65
|
+
| **Sync strategy** | Real-time (WebSocket/SSE), eventual consistency (message queue), batch (cron), offline-first (CRDT/merge) |
|
|
66
|
+
| **Shared contract layer** | How are data shapes shared? Monorepo with shared package? Published npm/crate package? Code generation from OpenAPI/protobuf? |
|
|
67
|
+
| **Auth federation** | Shared auth server with SSO? OAuth2 token exchange? Separate auth per surface? |
|
|
68
|
+
| **Conflict resolution** | Last-write-wins, operational transform, CRDT, manual resolution, server-authoritative |
|
|
69
|
+
| **Offline support** | Which surfaces work offline? What data is cached locally? How are conflicts resolved on reconnect? |
|
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Technical Writer
|
|
3
|
+
description: Create clear, comprehensive technical documentation for any audience
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Technical Writer
|
|
7
|
+
|
|
8
|
+
Create clear, comprehensive technical documentation for any audience.
|
|
9
|
+
|
|
10
|
+
## When to Use This Skill
|
|
11
|
+
- Write user documentation for a feature
|
|
12
|
+
- Create a tutorial for setting up a development environment
|
|
13
|
+
- Document system architecture
|
|
14
|
+
- Write a troubleshooting guide
|
|
15
|
+
- Create onboarding documentation for new developers
|
|
16
|
+
- Write a README for a project
|
|
17
|
+
|
|
18
|
+
## Instructions
|
|
19
|
+
|
|
20
|
+
When a user needs technical documentation:
|
|
21
|
+
|
|
22
|
+
1. **Identify Documentation Type**:
|
|
23
|
+
- User guide / end-user documentation
|
|
24
|
+
- Developer documentation / API docs
|
|
25
|
+
- System architecture documentation
|
|
26
|
+
- Tutorial / how-to guide
|
|
27
|
+
- Troubleshooting guide
|
|
28
|
+
- README file
|
|
29
|
+
- Release notes / changelog
|
|
30
|
+
- Onboarding documentation
|
|
31
|
+
- Knowledge base article
|
|
32
|
+
- Standard Operating Procedure (SOP)
|
|
33
|
+
|
|
34
|
+
2. **Determine Audience**:
|
|
35
|
+
- Technical level (beginner, intermediate, expert)
|
|
36
|
+
- Role (end user, developer, admin, stakeholder)
|
|
37
|
+
- Prior knowledge assumptions
|
|
38
|
+
- Context (internal team, external customers, open source community)
|
|
39
|
+
|
|
40
|
+
3. **Structure Documentation**:
|
|
41
|
+
|
|
42
|
+
**User Guide Format**:
|
|
43
|
+
```markdown
|
|
44
|
+
# [Product/Feature Name]
|
|
45
|
+
|
|
46
|
+
## Overview
|
|
47
|
+
[What it is, what it does, why use it - 2-3 sentences]
|
|
48
|
+
|
|
49
|
+
## Prerequisites
|
|
50
|
+
- [Required knowledge]
|
|
51
|
+
- [Required tools/access]
|
|
52
|
+
- [System requirements]
|
|
53
|
+
|
|
54
|
+
## Getting Started
|
|
55
|
+
[Quick start guide with minimal steps to first success]
|
|
56
|
+
|
|
57
|
+
## Key Concepts
|
|
58
|
+
### [Concept 1]
|
|
59
|
+
[Explanation with examples]
|
|
60
|
+
|
|
61
|
+
## Common Tasks
|
|
62
|
+
### How to [Task]
|
|
63
|
+
1. [Step]
|
|
64
|
+
2. [Step]
|
|
65
|
+
3. [Expected result]
|
|
66
|
+
|
|
67
|
+
## Advanced Features
|
|
68
|
+
[Optional advanced functionality]
|
|
69
|
+
|
|
70
|
+
## Troubleshooting
|
|
71
|
+
### Problem: [Common issue]
|
|
72
|
+
**Symptoms**: [What users see]
|
|
73
|
+
**Solution**: [How to fix]
|
|
74
|
+
|
|
75
|
+
## FAQ
|
|
76
|
+
**Q: [Question]**
|
|
77
|
+
A: [Answer]
|
|
78
|
+
|
|
79
|
+
## Additional Resources
|
|
80
|
+
- [Link to related docs]
|
|
81
|
+
- [Support channels]
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
**Tutorial Format**:
|
|
85
|
+
```markdown
|
|
86
|
+
# How to [Accomplish Goal]
|
|
87
|
+
|
|
88
|
+
**Time required**: [X minutes]
|
|
89
|
+
**Difficulty**: [Beginner/Intermediate/Advanced]
|
|
90
|
+
|
|
91
|
+
## What You'll Learn
|
|
92
|
+
- [Learning objective 1]
|
|
93
|
+
- [Learning objective 2]
|
|
94
|
+
|
|
95
|
+
## Prerequisites
|
|
96
|
+
- [Required knowledge]
|
|
97
|
+
- [Tools needed]
|
|
98
|
+
|
|
99
|
+
## Step-by-Step Instructions
|
|
100
|
+
|
|
101
|
+
### 1. [First Major Step]
|
|
102
|
+
[Explanation of why this step matters]
|
|
103
|
+
|
|
104
|
+
### 2. [Next Major Step]
|
|
105
|
+
[Continue pattern]
|
|
106
|
+
|
|
107
|
+
## Verification
|
|
108
|
+
[How to confirm it worked]
|
|
109
|
+
|
|
110
|
+
## Next Steps
|
|
111
|
+
[What to learn next]
|
|
112
|
+
|
|
113
|
+
## Troubleshooting
|
|
114
|
+
[Common issues]
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
**Architecture Documentation Format**:
|
|
118
|
+
```markdown
|
|
119
|
+
# [System Name] Architecture
|
|
120
|
+
|
|
121
|
+
## Overview
|
|
122
|
+
[High-level description, purpose, key characteristics]
|
|
123
|
+
|
|
124
|
+
## Architecture Diagram
|
|
125
|
+
[ASCII diagram or description for diagram]
|
|
126
|
+
|
|
127
|
+
## Components
|
|
128
|
+
### [Component 1]
|
|
129
|
+
**Purpose**: [What it does]
|
|
130
|
+
**Technology**: [Stack/framework]
|
|
131
|
+
**Responsibilities**:
|
|
132
|
+
- [Responsibility 1]
|
|
133
|
+
- [Responsibility 2]
|
|
134
|
+
|
|
135
|
+
**Interfaces**:
|
|
136
|
+
- Input: [Data/requests it receives]
|
|
137
|
+
- Output: [Data/responses it produces]
|
|
138
|
+
|
|
139
|
+
## Data Flow
|
|
140
|
+
1. [Step-by-step flow through system]
|
|
141
|
+
|
|
142
|
+
## Technology Stack
|
|
143
|
+
- **Frontend**: [Technologies]
|
|
144
|
+
- **Backend**: [Technologies]
|
|
145
|
+
- **Database**: [Technologies]
|
|
146
|
+
- **Infrastructure**: [Technologies]
|
|
147
|
+
|
|
148
|
+
## Design Decisions
|
|
149
|
+
### Why [Technology/Pattern]?
|
|
150
|
+
[Rationale, alternatives considered, trade-offs]
|
|
151
|
+
|
|
152
|
+
## Scalability Considerations
|
|
153
|
+
[How system scales, bottlenecks, mitigation strategies]
|
|
154
|
+
|
|
155
|
+
## Security
|
|
156
|
+
[Authentication, authorization, data protection]
|
|
157
|
+
|
|
158
|
+
## Monitoring & Observability
|
|
159
|
+
[Logging, metrics, alerting]
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
4. **Apply Technical Writing Best Practices**:
|
|
163
|
+
|
|
164
|
+
**Clarity**:
|
|
165
|
+
- Use short sentences (aim for 15-20 words)
|
|
166
|
+
- Avoid jargon or define it when first used
|
|
167
|
+
- Use active voice ("Click the button" not "The button should be clicked")
|
|
168
|
+
- Be specific ("Set timeout to 30 seconds" not "Set a reasonable timeout")
|
|
169
|
+
|
|
170
|
+
**Structure**:
|
|
171
|
+
- Use descriptive headings
|
|
172
|
+
- Break content into scannable sections
|
|
173
|
+
- Use numbered lists for sequences
|
|
174
|
+
- Use bullet points for unordered items
|
|
175
|
+
- Add table of contents for long docs
|
|
176
|
+
|
|
177
|
+
**Visuals**:
|
|
178
|
+
- Include screenshots with annotations
|
|
179
|
+
- Add code examples with syntax highlighting
|
|
180
|
+
- Use diagrams for complex concepts
|
|
181
|
+
- Show expected outputs
|
|
182
|
+
- Add tables for comparison or reference
|
|
183
|
+
|
|
184
|
+
**Code Examples**:
|
|
185
|
+
- Include language identifier
|
|
186
|
+
- Show both good and bad examples
|
|
187
|
+
- Add comments explaining complex parts
|
|
188
|
+
- Use realistic, runnable examples
|
|
189
|
+
- Include error handling
|
|
190
|
+
|
|
191
|
+
**User-Focused**:
|
|
192
|
+
- Start with most common use case
|
|
193
|
+
- Include "why" not just "how"
|
|
194
|
+
- Anticipate user questions
|
|
195
|
+
- Address common pitfalls
|
|
196
|
+
- Provide troubleshooting
|
|
197
|
+
|
|
198
|
+
5. **Special Documentation Types**:
|
|
199
|
+
|
|
200
|
+
**README.md**:
|
|
201
|
+
- Project name and description
|
|
202
|
+
- Installation instructions
|
|
203
|
+
- Quick start example
|
|
204
|
+
- Features list
|
|
205
|
+
- Documentation links
|
|
206
|
+
- Contributing guidelines
|
|
207
|
+
- License
|
|
208
|
+
|
|
209
|
+
**Release Notes**:
|
|
210
|
+
- Version number and date
|
|
211
|
+
- New features
|
|
212
|
+
- Improvements
|
|
213
|
+
- Bug fixes
|
|
214
|
+
- Breaking changes
|
|
215
|
+
- Migration guide
|
|
216
|
+
- Deprecation notices
|
|
217
|
+
|
|
218
|
+
**Troubleshooting Guide**:
|
|
219
|
+
- Symptom-based organization
|
|
220
|
+
- Root cause analysis
|
|
221
|
+
- Step-by-step resolution
|
|
222
|
+
- Prevention tips
|
|
223
|
+
- When to escalate
|
|
224
|
+
|
|
225
|
+
## Output Quality
|
|
226
|
+
Ensure documentation:
|
|
227
|
+
- Has clear, descriptive title
|
|
228
|
+
- Starts with overview/context
|
|
229
|
+
- Lists prerequisites upfront
|
|
230
|
+
- Uses consistent formatting
|
|
231
|
+
- Includes code examples where appropriate
|
|
232
|
+
- Shows expected outputs
|
|
233
|
+
- Has troubleshooting section
|
|
234
|
+
- Uses appropriate technical level for audience
|
|
235
|
+
- Is structured logically (simple to complex)
|
|
236
|
+
- Includes visual aids (diagrams, screenshots)
|
|
237
|
+
- Has table of contents for long docs
|
|
238
|
+
- Links to related documentation
|
|
239
|
+
- Is easy to scan
|
|
240
|
+
- Uses active voice
|
|
241
|
+
- Avoids ambiguity
|
|
242
|
+
- Includes examples from user perspective
|