Dev Kit Init

Quality Rules

• Be specific: Numbers, owners, environments, SLOs, data shapes, API examples, failure modes, rollout steps.
• Reduce fluff: Prefer bullets over paragraphs; keep sentences direct and active.
• Fit the audience:
  • Executives → outcomes and risks
  • Engineers → systems, APIs, data, failure paths
  • Ops → runbooks, monitors, alerts
• Terminology: Reuse domain terms from .dev-kit/docs/PROJECT.md; define new ones in a glossary section.

Document Type Structure Guides

• Project overview / proposal: summary, problem, goals/non-goals, users, scope, success metrics, timeline, risks, dependencies.
• Architecture / ADR: context, forces, options, decision, rationale, consequences, open questions, rollout/verification.
• API guide: purpose, auth, endpoints with request/response examples, status codes, idempotency, pagination, errors, rate limits, testing tips.
• Runbook / ops: symptoms, diagnosis steps, dashboards/logs, remediation, rollback, owners, on-call escalation.
• Onboarding: system map, prerequisites, setup steps, common tasks, troubleshooting, glossary.

Inputs to Request When Missing

• Single required argument: project description (product, audience, goal, desired doc depth).
• If absent in code or description, ask for: constraints (latency/SLOs, compliance, data residency, budget), integrations, data sources, critical paths, environments, risks.
• Stack details: languages, frameworks, infra/services, CI/CD, secrets, observability, feature flags, migration strategy.
• Testing and quality: coverage expectations, test matrix, performance criteria, accessibility, security controls.

Output Expectations

• Markdown only. Use tables for matrices or comparisons when helpful.
• Include a brief "Assumptions / Open Questions" section if anything is unclear.
• Keep references to context explicit (cite sections or phrases from the provided files when relevant).
• If asked for multiple docs, produce them in separate titled sections.
• After TECH.md generation, automatically trigger research for major tech stack components with version-specific details.

Example Usage

• /dev-kit.init Assets Studio: web app for GenAI asset creation; generate PROJECT.md and TECH.md

Run this workflow every time; do not skip clarification or outline steps when inputs are uncertain.