opencode-skills-collection 4.1.1 → 4.1.3
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.
Potentially problematic release.
This version of opencode-skills-collection might be problematic. Click here for more details.
- package/bundled-skills/.antigravity-install-manifest.json +133 -1
- package/bundled-skills/360-feedback-system/SKILL.md +481 -0
- package/bundled-skills/access-matrix/SKILL.md +338 -0
- package/bundled-skills/accounting-audit-system-builder/SKILL.md +302 -0
- package/bundled-skills/accounting-audit-system-builder/references/catalog.md +114 -0
- package/bundled-skills/accounting-software-selection/SKILL.md +427 -0
- package/bundled-skills/accounting-software-selection/references/build-artifacts.md +362 -0
- package/bundled-skills/accounting-software-selection/references/common-pitfalls.md +44 -0
- package/bundled-skills/accounting-software-selection/references/field-reference.md +93 -0
- package/bundled-skills/accounting-software-selection/references/select-options.md +202 -0
- package/bundled-skills/admin-access-register/SKILL.md +381 -0
- package/bundled-skills/advanced-analytics-dashboard/SKILL.md +318 -0
- package/bundled-skills/ai-image-generation-studio/SKILL.md +259 -0
- package/bundled-skills/ai-logo-maker/SKILL.md +259 -0
- package/bundled-skills/ai-multilingual-dubbing/SKILL.md +259 -0
- package/bundled-skills/ai-photo-restyler/SKILL.md +259 -0
- package/bundled-skills/ai-podcast-voiceover/SKILL.md +259 -0
- package/bundled-skills/alumni-re-hire-tracker/SKILL.md +314 -0
- package/bundled-skills/announcement-board/SKILL.md +336 -0
- package/bundled-skills/antigravity-maintainer-batch-release/SKILL.md +63 -4
- package/bundled-skills/asset-it-management/SKILL.md +407 -0
- package/bundled-skills/attendance/SKILL.md +331 -0
- package/bundled-skills/audit-log/SKILL.md +314 -0
- package/bundled-skills/audit-preparation/SKILL.md +416 -0
- package/bundled-skills/beatra/SKILL.md +260 -0
- package/bundled-skills/board-governance/SKILL.md +360 -0
- package/bundled-skills/brand-growth-system-builder/SKILL.md +360 -0
- package/bundled-skills/brand-kit-print-collateral/SKILL.md +498 -0
- package/bundled-skills/buddy-program-manager/SKILL.md +329 -0
- package/bundled-skills/budget-cash-flow/SKILL.md +352 -0
- package/bundled-skills/busabase/SKILL.md +118 -0
- package/bundled-skills/business-email-template/SKILL.md +480 -0
- package/bundled-skills/business-email-template/references/common-pitfalls.md +30 -0
- package/bundled-skills/business-website-setup/SKILL.md +489 -0
- package/bundled-skills/business-website-setup/references/common-pitfalls.md +32 -0
- package/bundled-skills/candidate-talent-pool/SKILL.md +359 -0
- package/bundled-skills/capacity-workload-planner/SKILL.md +354 -0
- package/bundled-skills/changelog-entry/SKILL.md +141 -0
- package/bundled-skills/clients-accounts/SKILL.md +398 -0
- package/bundled-skills/code-of-conduct/SKILL.md +488 -0
- package/bundled-skills/code-of-conduct/references/common-pitfalls.md +31 -0
- package/bundled-skills/company-email-accounts/SKILL.md +404 -0
- package/bundled-skills/competency-matrix/SKILL.md +335 -0
- package/bundled-skills/contract-document-renewal/SKILL.md +396 -0
- package/bundled-skills/course-upskilling-requests/SKILL.md +354 -0
- package/bundled-skills/credit-cycle-analysis/SKILL.md +303 -0
- package/bundled-skills/credit-cycle-analysis/references/best-practices.md +35 -0
- package/bundled-skills/credit-cycle-analysis/references/common-pitfalls.md +5 -0
- package/bundled-skills/credit-cycle-analysis/references/examples.md +34 -0
- package/bundled-skills/credit-cycle-analysis/references/field-reference.md +47 -0
- package/bundled-skills/credit-cycle-analysis/references/how-it-works.md +494 -0
- package/bundled-skills/credit-cycle-analysis/references/security-notes.md +16 -0
- package/bundled-skills/credit-cycle-analysis/references/select-options.md +32 -0
- package/bundled-skills/csv-manual-export/SKILL.md +499 -0
- package/bundled-skills/csv-manual-export/references/common-pitfalls.md +19 -0
- package/bundled-skills/culture-retention/SKILL.md +346 -0
- package/bundled-skills/data-export-engine/SKILL.md +308 -0
- package/bundled-skills/data-privacy-controls/SKILL.md +317 -0
- package/bundled-skills/day-book/SKILL.md +499 -0
- package/bundled-skills/day-book/references/best-practices.md +32 -0
- package/bundled-skills/day-book/references/common-pitfalls.md +58 -0
- package/bundled-skills/day-book/references/field-reference.md +45 -0
- package/bundled-skills/day-book/references/how-it-works.md +7 -0
- package/bundled-skills/day-book/references/related-skills.md +18 -0
- package/bundled-skills/day-book/references/relations.md +14 -0
- package/bundled-skills/day-book/references/reusable-prompt.md +50 -0
- package/bundled-skills/day-book/references/security-safety-notes.md +19 -0
- package/bundled-skills/day-book/references/select-options.md +38 -0
- package/bundled-skills/deep-research-framework/SKILL.md +81 -0
- package/bundled-skills/dei-dashboard/SKILL.md +307 -0
- package/bundled-skills/design-theme-guide/SKILL.md +472 -0
- package/bundled-skills/disciplinary-pip-tracker/SKILL.md +345 -0
- package/bundled-skills/document-management-system/SKILL.md +328 -0
- package/bundled-skills/ecommerce-listing-image-set/SKILL.md +259 -0
- package/bundled-skills/employee-suggestion-hub/SKILL.md +322 -0
- package/bundled-skills/esop-equity-tracker/SKILL.md +331 -0
- package/bundled-skills/events-activities/SKILL.md +355 -0
- package/bundled-skills/expense-accounting/SKILL.md +496 -0
- package/bundled-skills/expense-accounting/references/common-pitfalls.md +41 -0
- package/bundled-skills/expense-accounting/references/related-skills.md +11 -0
- package/bundled-skills/expense-accounting/references/reusable-prompt.md +36 -0
- package/bundled-skills/expense-management/SKILL.md +351 -0
- package/bundled-skills/five-axis-code-review/SKILL.md +78 -0
- package/bundled-skills/free-design-resources/SKILL.md +480 -0
- package/bundled-skills/free-design-resources/references/common-pitfalls.md +44 -0
- package/bundled-skills/free-design-resources/references/related-skills.md +24 -0
- package/bundled-skills/free-design-resources/references/reusable-prompt.md +12 -0
- package/bundled-skills/gamification-engine/SKILL.md +307 -0
- package/bundled-skills/gbp-local-seo-intent/SKILL.md +466 -0
- package/bundled-skills/gbp-local-seo-intent/references/best-practices.md +41 -0
- package/bundled-skills/gbp-local-seo-intent/references/common-pitfalls.md +40 -0
- package/bundled-skills/gbp-local-seo-intent/references/related-skills.md +17 -0
- package/bundled-skills/gbp-local-seo-intent/references/reusable-prompt.md +11 -0
- package/bundled-skills/gbp-local-seo-intent/references/security-safety-notes.md +27 -0
- package/bundled-skills/git-commit-message/SKILL.md +76 -0
- package/bundled-skills/health-wellness/SKILL.md +334 -0
- package/bundled-skills/idea-to-blueprint/LICENSE +21 -0
- package/bundled-skills/idea-to-blueprint/SKILL.md +260 -0
- package/bundled-skills/idea-to-blueprint/assets/AGENTS.md.template +38 -0
- package/bundled-skills/idea-to-blueprint/assets/CLAUDE.md.template +38 -0
- package/bundled-skills/idea-to-blueprint/assets/DECISIONS.md.template +14 -0
- package/bundled-skills/idea-to-blueprint/assets/PROGRESS.md.template +47 -0
- package/bundled-skills/idea-to-blueprint/assets/session-prompt.md +23 -0
- package/bundled-skills/idea-to-blueprint/references/architecture-decisions.md +202 -0
- package/bundled-skills/idea-to-blueprint/references/blueprint-template.md +259 -0
- package/bundled-skills/idea-to-blueprint/references/code-quality-and-review.md +216 -0
- package/bundled-skills/idea-to-blueprint/references/design-minimal.md +96 -0
- package/bundled-skills/idea-to-blueprint/references/edge-case-catalog.md +239 -0
- package/bundled-skills/idea-to-blueprint/references/intake-questions.md +105 -0
- package/bundled-skills/idea-to-blueprint/references/research-protocol.md +196 -0
- package/bundled-skills/idea-to-blueprint/references/session-protocol.md +133 -0
- package/bundled-skills/idea-to-blueprint/references/stories-ac-tests.md +194 -0
- package/bundled-skills/idea-to-blueprint/references/ux-writing-guide.md +128 -0
- package/bundled-skills/idea-to-blueprint/scripts/lint_blueprint.py +460 -0
- package/bundled-skills/intern-program/SKILL.md +354 -0
- package/bundled-skills/internal-communication/SKILL.md +318 -0
- package/bundled-skills/inventory-stock-reconciliation/SKILL.md +470 -0
- package/bundled-skills/inventory-stock-reconciliation/references/best-practices.md +18 -0
- package/bundled-skills/inventory-stock-reconciliation/references/common-pitfalls.md +42 -0
- package/bundled-skills/inventory-stock-reconciliation/references/related-skills.md +13 -0
- package/bundled-skills/inventory-stock-reconciliation/references/relations.md +8 -0
- package/bundled-skills/inventory-stock-reconciliation/references/reusable-prompt.md +31 -0
- package/bundled-skills/inventory-stock-reconciliation/references/security-safety-notes.md +17 -0
- package/bundled-skills/inventory-stock-reconciliation/references/select-options.md +45 -0
- package/bundled-skills/invoices-billing/SKILL.md +385 -0
- package/bundled-skills/issue-grievance-tracker/SKILL.md +400 -0
- package/bundled-skills/json-schema-manual/SKILL.md +309 -0
- package/bundled-skills/json-schema-manual/references/best-practices.md +9 -0
- package/bundled-skills/json-schema-manual/references/common-pitfalls.md +25 -0
- package/bundled-skills/json-schema-manual/references/input-modules.md +203 -0
- package/bundled-skills/json-schema-manual/references/related-skills.md +8 -0
- package/bundled-skills/json-schema-manual/references/reusable-prompt.md +10 -0
- package/bundled-skills/json-schema-manual/references/security-safety-notes.md +13 -0
- package/bundled-skills/knowledge-base/SKILL.md +318 -0
- package/bundled-skills/kpi-tracker/SKILL.md +345 -0
- package/bundled-skills/learning-career-development/SKILL.md +349 -0
- package/bundled-skills/leave-management/SKILL.md +341 -0
- package/bundled-skills/legal-compliance-vault/SKILL.md +324 -0
- package/bundled-skills/linktree-link-hub/SKILL.md +453 -0
- package/bundled-skills/liuguang-banlan-ui/SKILL.md +22 -18
- package/bundled-skills/liuguang-banlan-ui/assets/starter/launcher.css +2 -2
- package/bundled-skills/liuguang-banlan-ui/assets/starter/obsidian/index.html +5 -4
- package/bundled-skills/liuguang-banlan-ui/assets/starter/obsidian/theme-config.js +3 -10
- package/bundled-skills/liuguang-banlan-ui/assets/starter/obsidian/theme.css +48 -62
- package/bundled-skills/liuguang-banlan-ui/assets/starter/opal/index.html +5 -4
- package/bundled-skills/liuguang-banlan-ui/assets/starter/opal/theme-config.js +27 -35
- package/bundled-skills/liuguang-banlan-ui/assets/starter/opal/theme.css +48 -62
- package/bundled-skills/liuguang-banlan-ui/assets/starter/shared/spectral-field.js +135 -148
- package/bundled-skills/liuguang-banlan-ui/references/style-contract.md +26 -7
- package/bundled-skills/liuguang-banlan-ui/references/verification.md +19 -7
- package/bundled-skills/liuguang-banlan-ui/scripts/measure_preview.py +78 -47
- package/bundled-skills/liuguang-banlan-ui/scripts/serve_preview.py +35 -0
- package/bundled-skills/liuguang-banlan-ui/scripts/validate_manifest.py +34 -3
- package/bundled-skills/liuguang-banlan-ui/tests/test_measure_preview.py +119 -0
- package/bundled-skills/liuguang-banlan-ui/tests/test_serve_preview.py +38 -0
- package/bundled-skills/liuguang-banlan-ui/tests/test_validate_manifest.py +73 -0
- package/bundled-skills/logo-image-design/SKILL.md +459 -0
- package/bundled-skills/loki-mode/examples/todo-app-generated/frontend/package-lock.json +12 -12
- package/bundled-skills/loki-mode/examples/todo-app-generated/frontend/package.json +1 -1
- package/bundled-skills/meeting-notes/SKILL.md +80 -0
- package/bundled-skills/mentorship-program/SKILL.md +332 -0
- package/bundled-skills/mirrord/SKILL.md +90 -0
- package/bundled-skills/monthly-closing-statements/SKILL.md +488 -0
- package/bundled-skills/monthly-closing-statements/references/related-skills.md +17 -0
- package/bundled-skills/monthly-closing-statements/references/reusable-prompt.md +8 -0
- package/bundled-skills/music-generation-studio/SKILL.md +259 -0
- package/bundled-skills/notification-reminder-hub/SKILL.md +324 -0
- package/bundled-skills/notion-manual-import/SKILL.md +376 -0
- package/bundled-skills/notion-manual-import/references/best-practices.md +10 -0
- package/bundled-skills/notion-manual-import/references/common-pitfalls.md +26 -0
- package/bundled-skills/notion-manual-import/references/input-modules.md +203 -0
- package/bundled-skills/notion-manual-import/references/related-skills.md +7 -0
- package/bundled-skills/notion-manual-import/references/reusable-prompt.md +8 -0
- package/bundled-skills/notion-manual-import/references/security-safety-notes.md +15 -0
- package/bundled-skills/observability-cloud-planning/SKILL.md +487 -0
- package/bundled-skills/observability-cloud-planning/references/common-pitfalls.md +39 -0
- package/bundled-skills/observability-cloud-planning/references/related-skills.md +20 -0
- package/bundled-skills/observability-cloud-planning/references/reusable-prompt.md +12 -0
- package/bundled-skills/observability-cloud-planning/references/security-safety-notes.md +30 -0
- package/bundled-skills/offboarding-exit/SKILL.md +343 -0
- package/bundled-skills/offer-appointment/SKILL.md +351 -0
- package/bundled-skills/okr-system/SKILL.md +355 -0
- package/bundled-skills/onboarding-playbook/SKILL.md +292 -0
- package/bundled-skills/organization-design/SKILL.md +324 -0
- package/bundled-skills/party-ledger-reconciliation/SKILL.md +411 -0
- package/bundled-skills/payment-accounting/SKILL.md +421 -0
- package/bundled-skills/payments-received/SKILL.md +315 -0
- package/bundled-skills/payroll-finance/SKILL.md +351 -0
- package/bundled-skills/people-directory/SKILL.md +459 -0
- package/bundled-skills/performance-management/SKILL.md +367 -0
- package/bundled-skills/petty-cash-management/SKILL.md +448 -0
- package/bundled-skills/policy-acknowledgement/SKILL.md +314 -0
- package/bundled-skills/policy-library/SKILL.md +327 -0
- package/bundled-skills/poster-design-studio/SKILL.md +259 -0
- package/bundled-skills/pre-boarding/SKILL.md +326 -0
- package/bundled-skills/presentation-deck/SKILL.md +491 -0
- package/bundled-skills/presentation-deck/references/related-skills.md +19 -0
- package/bundled-skills/presentation-deck/references/reusable-prompt.md +11 -0
- package/bundled-skills/probation-tracker/SKILL.md +347 -0
- package/bundled-skills/product-photo-studio/SKILL.md +259 -0
- package/bundled-skills/project-based-performance/SKILL.md +323 -0
- package/bundled-skills/projects-work-management/SKILL.md +368 -0
- package/bundled-skills/promotion-upgrade-requests/SKILL.md +377 -0
- package/bundled-skills/purchase-accounting/SKILL.md +414 -0
- package/bundled-skills/receipt-accounting/SKILL.md +424 -0
- package/bundled-skills/recognition-rewards/SKILL.md +324 -0
- package/bundled-skills/recruitment-pipeline/SKILL.md +399 -0
- package/bundled-skills/remote-work-tracker/SKILL.md +306 -0
- package/bundled-skills/repo-foundation/SKILL.md +166 -0
- package/bundled-skills/repo-foundation/references/LICENSE.md +21 -0
- package/bundled-skills/repo-foundation/references/bootstrap.md +63 -0
- package/bundled-skills/repo-foundation/references/companion.md +9 -0
- package/bundled-skills/repo-foundation/references/continuity.md +50 -0
- package/bundled-skills/repo-foundation/references/evolution.md +60 -0
- package/bundled-skills/repo-foundation/references/migration-examples.md +53 -0
- package/bundled-skills/repo-foundation/references/shared-contracts.md +48 -0
- package/bundled-skills/repo-foundation/references/verification.md +50 -0
- package/bundled-skills/repo-native-refactor/SKILL.md +225 -0
- package/bundled-skills/repo-native-refactor/references/LICENSE.md +21 -0
- package/bundled-skills/repo-native-refactor/references/deterministic-tooling.md +101 -0
- package/bundled-skills/repo-native-refactor/references/error-reliability.md +117 -0
- package/bundled-skills/repo-native-refactor/references/finding-taxonomy.md +181 -0
- package/bundled-skills/repo-native-refactor/references/refactor-examples.md +77 -0
- package/bundled-skills/repo-native-refactor/references/repository-prose.md +157 -0
- package/bundled-skills/repo-native-refactor/references/repository-rehabilitation.md +94 -0
- package/bundled-skills/repo-native-refactor/references/semantic-risk.md +187 -0
- package/bundled-skills/repo-native-refactor/references/shared-contracts.md +48 -0
- package/bundled-skills/repo-native-refactor/references/testing-integrity.md +103 -0
- package/bundled-skills/reports-analytics/SKILL.md +320 -0
- package/bundled-skills/salary-benchmarking/SKILL.md +318 -0
- package/bundled-skills/salary-wage-accounting/SKILL.md +412 -0
- package/bundled-skills/sales-accounting/SKILL.md +494 -0
- package/bundled-skills/sales-accounting/references/common-pitfalls.md +28 -0
- package/bundled-skills/sales-accounting/references/related-skills.md +13 -0
- package/bundled-skills/sales-accounting/references/reusable-prompt.md +8 -0
- package/bundled-skills/seo-directory-backlinks/SKILL.md +484 -0
- package/bundled-skills/seo-directory-backlinks/references/common-pitfalls.md +36 -0
- package/bundled-skills/seo-directory-backlinks/references/related-skills.md +15 -0
- package/bundled-skills/seo-directory-backlinks/references/reusable-prompt.md +11 -0
- package/bundled-skills/skill-gap-analysis/SKILL.md +338 -0
- package/bundled-skills/social-media-setup/SKILL.md +477 -0
- package/bundled-skills/social-media-setup/references/common-pitfalls.md +34 -0
- package/bundled-skills/social-media-setup/references/related-skills.md +19 -0
- package/bundled-skills/social-media-setup/references/reusable-prompt.md +11 -0
- package/bundled-skills/social-media-setup/references/security-safety-notes.md +27 -0
- package/bundled-skills/sop-company-wiki/SKILL.md +324 -0
- package/bundled-skills/source-document-filing/SKILL.md +368 -0
- package/bundled-skills/spreadsheet-manual-build/SKILL.md +493 -0
- package/bundled-skills/spreadsheet-manual-build/references/best-practices.md +9 -0
- package/bundled-skills/spreadsheet-manual-build/references/common-pitfalls.md +22 -0
- package/bundled-skills/spreadsheet-manual-build/references/related-skills.md +8 -0
- package/bundled-skills/spreadsheet-manual-build/references/reusable-prompt.md +9 -0
- package/bundled-skills/spreadsheet-manual-build/references/security-safety-notes.md +16 -0
- package/bundled-skills/stakeholder-investor-reports/SKILL.md +303 -0
- package/bundled-skills/suno-lyrics-to-song/SKILL.md +259 -0
- package/bundled-skills/talking-avatar-video/SKILL.md +260 -0
- package/bundled-skills/tax-register/SKILL.md +363 -0
- package/bundled-skills/tds-booking-payment/SKILL.md +405 -0
- package/bundled-skills/team-calendar/SKILL.md +312 -0
- package/bundled-skills/tech-writing-proofread/SKILL.md +78 -0
- package/bundled-skills/telegram/assets/boilerplate/nodejs/package-lock.json +3 -3
- package/bundled-skills/telegram/assets/boilerplate/nodejs/package.json +1 -0
- package/bundled-skills/template-library/SKILL.md +304 -0
- package/bundled-skills/time-tracking/SKILL.md +353 -0
- package/bundled-skills/typescript-expert/scripts/ts_diagnostic.py +40 -19
- package/bundled-skills/vendor-contractor-management/SKILL.md +327 -0
- package/bundled-skills/viral-video-teardown-remake/SKILL.md +260 -0
- package/bundled-skills/voice-cloning-studio/SKILL.md +260 -0
- package/bundled-skills/voiceover-narration-studio/SKILL.md +259 -0
- package/bundled-skills/whatsapp-cloud-api/assets/boilerplate/nodejs/package-lock.json +3 -3
- package/bundled-skills/whatsapp-cloud-api/assets/boilerplate/nodejs/package.json +1 -0
- package/bundled-skills/youtube-summarizer/SKILL.md +3 -3
- package/package.json +1 -1
- package/skills_index.json +254 -0
|
@@ -0,0 +1,260 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: idea-to-blueprint
|
|
3
|
+
description: "Turn a raw product, app, bot or feature idea into one evidence-backed build blueprint (researched stack, epics, Given/When/Then criteria, tests) that coding agents build one epic per session."
|
|
4
|
+
category: planning
|
|
5
|
+
risk: safe
|
|
6
|
+
source: self
|
|
7
|
+
source_type: self
|
|
8
|
+
source_repo: iniesohidham/idea-to-blueprint
|
|
9
|
+
date_added: "2026-09-30"
|
|
10
|
+
author: iniesohidham
|
|
11
|
+
tags: [prd, specification, product-planning, user-stories, acceptance-criteria, tech-stack, agentic-engineering]
|
|
12
|
+
tools: [claude, codex]
|
|
13
|
+
license: "MIT"
|
|
14
|
+
license_source: "https://github.com/iniesohidham/idea-to-blueprint/blob/main/LICENSE"
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Idea to Blueprint
|
|
18
|
+
|
|
19
|
+
## Overview
|
|
20
|
+
|
|
21
|
+
Turn a raw idea into a single markdown document that is complete enough for a coding agent to build the product epic by epic, in fresh sessions, without ever having to guess. The blueprint is not a "PRD" in the loose sense: it is the product's only shared memory between the human, the research, and every future build session.
|
|
22
|
+
|
|
23
|
+
The skill runs intake questions, web research and competitor benchmarking, then writes one Markdown blueprint: architecture drivers and style, a version-pinned stack with evidence tags, a quality gate, personas, flows, UX copy, edge cases, and epics broken into stories with Given/When/Then acceptance criteria, tests and a Definition of Done. The blueprint embeds a session protocol so Claude Code or Codex builds it one epic per fresh session.
|
|
24
|
+
|
|
25
|
+
This is the author's own skill, published at [iniesohidham/idea-to-blueprint](https://github.com/iniesohidham/idea-to-blueprint) under the MIT license (see `LICENSE`). The files in `references/`, `assets/` and `scripts/` are unchanged copies of the upstream files; this `SKILL.md` adds the catalog sections (Overview, When to Use, Examples, Limitations, safety notes) around the upstream instructions.
|
|
26
|
+
|
|
27
|
+
## When to Use This Skill
|
|
28
|
+
|
|
29
|
+
- Use when someone shares a product, app, bot or feature idea (even 2–3 lines) and wants a PRD, spec, backlog, epics, user stories, roadmap or MVP plan, even without saying "PRD".
|
|
30
|
+
- Use when the user wants deep web research, market research or competitor benchmarking before anything is built.
|
|
31
|
+
- Use when the user wants an architecture or tech-stack recommendation with justification and pinned versions, or code-quality and review standards for a new product.
|
|
32
|
+
- Use when the user asks for "a plan for Claude Code/Codex" that a coding agent can execute one epic at a time.
|
|
33
|
+
- Prefer it over lighter PRD skills when research depth, rigor or zero hallucination matters.
|
|
34
|
+
- Do not use it to review an existing PRD, to compare two frameworks in isolation, or to write a single piece of UX copy.
|
|
35
|
+
|
|
36
|
+
## How It Works
|
|
37
|
+
|
|
38
|
+
Run this skill on the strongest model available at the highest effort/thinking setting the harness offers. If you cannot tell whether that is the case, say so once at the start and continue.
|
|
39
|
+
|
|
40
|
+
### Why this document has to be different
|
|
41
|
+
|
|
42
|
+
A build session that starts from a blank context has exactly two sources of truth: the repo and this blueprint. Whatever is missing, vague, or wrong in the blueprint becomes a guess in code. So the whole skill is organized around three habits:
|
|
43
|
+
|
|
44
|
+
1. **Evidence or silence.** Every claim about the outside world (a library, a version, a competitor, a regulation, a market figure, a service's availability in a country) carries an evidence tag: `[VERIFIED — <source>, <date>]`, `[ASSUMED — <why>]`, or `[UNKNOWN → OQ-nn]` (routed to Open Questions). You never fill a gap with a plausible-sounding guess, because the reader has no way to tell your guess from a fact.
|
|
45
|
+
2. **Decide, don't hedge.** "Use X or Y" pushes the decision onto an agent with less context than you have now. Make the call, record the alternatives and why they lost.
|
|
46
|
+
3. **Write for zero context.** No "as discussed", no "the usual way". Every ID (persona, flow, screen, copy line, story, criterion) is unique and cross-referenced so a fresh session can resolve everything by search.
|
|
47
|
+
|
|
48
|
+
Everything below serves those three habits.
|
|
49
|
+
|
|
50
|
+
### Workflow
|
|
51
|
+
|
|
52
|
+
| Phase | What happens | Reference to read |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| 0. Intake | Parse the idea, do a 2–5 search warm-up, ask ONE batch of questions with defaults, wait | `references/intake-questions.md` |
|
|
55
|
+
| 1. Deep research | Understand the domain, benchmark competitors, derive the architecture drivers and shape, choose the stack for agentic engineering, verify the quality tooling, integrations and locale realities, collect UX benchmarks | `references/research-protocol.md`, `references/architecture-decisions.md`, `references/code-quality-and-review.md` |
|
|
56
|
+
| 2. Decision brief | Present the interpretation, personas, positioning, architecture drivers and shape, stack, quality gate, epic list and open questions in chat; get a go/correct | (template below) |
|
|
57
|
+
| 3. Write the blueprint | Write the document section by section, in chunks, into one `.md` file | `references/blueprint-template.md` plus the topic references it points to |
|
|
58
|
+
| 4. Lint & deliver | Run `scripts/lint_blueprint.py`, fix every error, deliver the file with a short wrap-up | (below) |
|
|
59
|
+
| 5. Build sessions | The user runs one epic per fresh Claude Code / Codex session using the protocol embedded in the blueprint | `references/session-protocol.md` |
|
|
60
|
+
|
|
61
|
+
Do not skip phases 0 and 2. The user explicitly wants to be asked before a long document is produced, and a two-minute checkpoint prevents a hundred pages built on a wrong interpretation. Do not run the phases out of order: research before the intake answers wastes searches on the wrong problem; writing before the brief is approved wastes the document.
|
|
62
|
+
|
|
63
|
+
Talk to the user in the language they wrote in. Persian in → Persian out for all chat and for the human-facing prose of the document (see Language convention).
|
|
64
|
+
|
|
65
|
+
### Phase 0 — Intake
|
|
66
|
+
|
|
67
|
+
Read `references/intake-questions.md` before asking anything. The rules that matter most:
|
|
68
|
+
|
|
69
|
+
- **Warm up first.** Run 2–5 quick searches on the idea so the questions are concrete ("I see three products in this space — A, B, C — which is closest to what you mean?") instead of generic.
|
|
70
|
+
- **One batch, defaults on every question.** Group the questions, put a sensible default next to each, and say that answering "defaults" or skipping any question is fine. Never ask in dribs and drabs.
|
|
71
|
+
- **Never ask what is already answered or inferable.** Cues from the message decide: language, currency, city names, local services, ".ir" domains, Jalali dates, "کاربر ایرانی" → the users are probably Iranian, so ask to *confirm* it in one line rather than asking "where are your users?".
|
|
72
|
+
- **Ask only what changes the architecture, the personas, or the scope.** A big product needs about 10–15 questions; a single feature needs 3–6.
|
|
73
|
+
- Where an elicitation UI tool exists (tappable options), use it for the closed questions; put open questions in prose right after.
|
|
74
|
+
|
|
75
|
+
When the answers arrive, write every unanswered item as an `[ASSUMED — …]` row in your notes; those rows become the Assumptions section later.
|
|
76
|
+
|
|
77
|
+
### Phase 1 — Deep research and benchmarking
|
|
78
|
+
|
|
79
|
+
Read `references/research-protocol.md` and follow its seven tracks **in order**:
|
|
80
|
+
|
|
81
|
+
- **A. Understand the idea** — domain concepts, vocabulary (this becomes the Glossary), how the problem is solved today, adjacent regulation to flag (never legal advice).
|
|
82
|
+
- **B. Benchmark** — 5–10 direct and indirect competitors (global, plus local ones when the market is Iran or another specific country), a feature matrix, best-in-class behaviour per key flow, common user complaints (paraphrased from reviews, never quoted), the gap this product fills, a positioning statement.
|
|
83
|
+
- **C. Architecture drivers and shape** (`references/architecture-decisions.md`) — derive ranked, *measurable* quality-attribute drivers from the personas, the scale ceiling, the failure cost of the core loop and the hosting reality; name the explicit non-drivers; score 2–3 candidate architecture styles against them; decide the shape, the module boundaries and the exit triggers that would justify revisiting it. Verify the framework's own recommended structure and whether boundary rules can be enforced mechanically in the candidate languages.
|
|
84
|
+
- **D. Stack for agentic engineering** — choose the language, framework, database, testing and tooling using the weighted criteria in the protocol (mainstream + heavily documented, strict static typing, one-command deterministic `check`, fast tests, LTS/stable, few dependencies, hosting fit for the market) **and** the drivers from C. Verify current stable versions, deprecations and licenses, and pin them.
|
|
85
|
+
- **E. Quality bar and tooling** (`references/code-quality-and-review.md`) — verify the tools that make the gate real for the chosen stack (formatter, strict lint config, typechecker flags, test runner, coverage, mutation testing if a maintained one exists, SAST and dependency audit, secret scanning, duplication detection, accessibility checks, architecture-rule library), the language's official style guide, the CI capability of the chosen host, the current security baseline for the category, and — only if the document will quote them — the current delivery-metric definitions and the current evidence on AI-authored code quality.
|
|
86
|
+
- **F. Integrations and locale realities** — payments, SMS/OTP, email, maps, push, app stores, hosting/CDN. For Iran, availability of foreign services changes with sanctions and filtering; verify today's status for each one you rely on and record the date.
|
|
87
|
+
- **G. UX benchmarks** — onboarding, empty states, error handling and accessibility norms from the best products in the space.
|
|
88
|
+
|
|
89
|
+
C before D matters. Choosing the framework first and then writing drivers that happen to justify it is the most common silent failure in a document like this, and it is undetectable in the finished file unless you ask whether any driver could have changed the answer.
|
|
90
|
+
|
|
91
|
+
Log every source (URL, title, access date) as you go; the Sources section is built from this log, not reconstructed afterwards. Expect 20–60 searches for a whole product; post a one-line progress note to the user every few searches ("benchmarking local competitors…", "verifying gateway sandbox…") so a long research phase never looks stalled. If web tools are unavailable, stop and tell the user: a blueprint written from memory alone cannot meet the no-hallucination bar, so either they enable web access or the document is delivered with every external fact marked `[UNVERIFIED]` and a warning on the cover.
|
|
92
|
+
|
|
93
|
+
### Phase 2 — Decision brief (checkpoint)
|
|
94
|
+
|
|
95
|
+
Before writing the document, post a brief in chat, roughly one screen long, in the user's language:
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
## Decision brief — <product name>
|
|
99
|
+
**How I read the idea:** 2–3 sentences. What it is, for whom, and the single outcome it delivers.
|
|
100
|
+
**Users are:** <market/country>, <B2C/B2B>, <language(s)>. (confirmed / assumed)
|
|
101
|
+
**Personas:** P1 <name> — one line. P2 … (3–5 max, plus anti-personas if useful)
|
|
102
|
+
**Benchmark in one paragraph:** who exists, what the best of them do, the gap we take.
|
|
103
|
+
**Architecture drivers (top 3):** AD-1 … (target), AD-2 …, AD-3 … — and what we are explicitly NOT optimising for.
|
|
104
|
+
**Shape (locked unless you object):** <style> — one line on why it beat <runner-up>, and the trigger that would make us revisit it.
|
|
105
|
+
**Stack (locked unless you object):** language · framework · DB · hosting · testing — one line each with the deciding reason and what the runner-up would have bought.
|
|
106
|
+
**Quality gate:** `check` = … (expected runtime …); critical e2e paths: …; what we will measure: …
|
|
107
|
+
**Design direction:** reference-based (<their reference>) or chosen (<system/style>) — one line.
|
|
108
|
+
**Epics in order:** E00 Foundation, E01 …, E02 … (titles only, 6–14 typical)
|
|
109
|
+
**Needs your answer before I write:** only genuinely blocking questions, numbered OQ-01…
|
|
110
|
+
**Everything else I will assume** as written in the Assumptions table.
|
|
111
|
+
Reply "go" to write the full blueprint, or correct any line.
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
If the user pre-authorised ("don't stop to ask, just write"), still post the brief and continue without waiting. Otherwise wait for the reply and fold corrections into the research notes.
|
|
115
|
+
|
|
116
|
+
### Phase 3 — Write the blueprint
|
|
117
|
+
|
|
118
|
+
Read `references/blueprint-template.md` and keep it open; it has the full section skeleton, the depth target per section, table formats and the ID schemes. Before writing the relevant sections, read the topic references it points to:
|
|
119
|
+
|
|
120
|
+
- Personas, flows, screens, design direction → `references/design-minimal.md`
|
|
121
|
+
- UX writing and copy tables → `references/ux-writing-guide.md` (its Persian pack when users are Iranian)
|
|
122
|
+
- Architecture drivers, style decision, module boundaries, fitness functions, decision records → `references/architecture-decisions.md`
|
|
123
|
+
- Quality gate, review checklist, test-quality rules, metrics and anti-metrics → `references/code-quality-and-review.md`
|
|
124
|
+
- Edge-case register and per-story edge cases → `references/edge-case-catalog.md`
|
|
125
|
+
- Stories, acceptance criteria, tests, DoD → `references/stories-ac-tests.md`
|
|
126
|
+
- Session protocol and Epic 0 → `references/session-protocol.md` and the files in `assets/`
|
|
127
|
+
|
|
128
|
+
Writing mechanics that matter:
|
|
129
|
+
|
|
130
|
+
- **Write in chunks.** Create the file with the cover and table of contents, then append one major section per write operation. A hundred-page document written in one output gets truncated or rushed; a document written section by section keeps its quality to the end.
|
|
131
|
+
- **IDs everywhere.** Personas `P1…`, flows `F-01…`, screens `S-01…`, copy lines `CP-<screen>-<n>`, entities `ENT-…`, epics `E00…`, stories `E03-S02`, criteria `AC-1…` inside a story, open questions `OQ-01…`, edge cases `EC-<cat>-<n>`. The linter and the future build sessions rely on them.
|
|
132
|
+
- **Machine-facing text in English, human-facing prose in the user's language** (details in Language convention). Every heading carries an English anchor so the linter and the coding agent can find sections regardless of prose language.
|
|
133
|
+
- **Depth beats brevity here.** The user has said a 100-page file is fine. The right length is whatever leaves no story, screen, copy line or edge case unspecified. Cut repetition, not content.
|
|
134
|
+
- **Every decision names its losers and its price.** Stack, architecture style, design system, auth model, data model: state the alternatives considered, the deciding reason, and *what the rejected option would have bought you*. A decision with no stated cost was not a decision.
|
|
135
|
+
- **Decide the shape before the tools.** Architecture drivers → architecture style → technology. If a driver could not have changed the technology choice, the drivers are decoration.
|
|
136
|
+
- **Quality is specified, not assumed.** The gate, the review checklist and the metrics go in the document with concrete commands and thresholds, because the reviewer is often one person reading a diff an agent produced in a minute, and a standard invented at review time is a different standard every time.
|
|
137
|
+
|
|
138
|
+
### Phase 4 — Lint and deliver
|
|
139
|
+
|
|
140
|
+
Run the linter and fix everything it reports as an error (warnings are judgement calls — resolve or justify them):
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
python3 <this skill's folder>/scripts/lint_blueprint.py <path/to/blueprint.md>
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
It checks required sections, placeholder text (TODO/TBD/…), story ID uniqueness, that every story has Acceptance Criteria / Edge cases / Tests, that every epic has a Definition of Done, that every `[UNKNOWN → OQ-nn]` resolves to an Open Questions entry, that tech-stack rows carry evidence tags, that every persona is used by at least one story, and that a Sources section exists with URLs. It also checks the quality layer: that architecture drivers `AD-n` exist with measurable targets and are referenced by the style decision, that a `check` command and a review checklist are present in the Quality section, that fitness functions are declared, and that no banned productivity metric (lines of code, commits per engineer, coverage as a target) appears.
|
|
147
|
+
|
|
148
|
+
Then do the human pass the linter cannot: read the Executive summary, one persona, one flow and one epic end-to-end as if you were a fresh session. Anything you had to infer, write down.
|
|
149
|
+
|
|
150
|
+
Deliver:
|
|
151
|
+
|
|
152
|
+
- In a chat surface with file tools: save under the outputs directory as `<product>-blueprint.md`, present it with the file-presenting tool.
|
|
153
|
+
- In Claude Code / Codex: save to `docs/BLUEPRINT.md` in the repo (or the path the user names) and also create `docs/PROGRESS.md`, `docs/DECISIONS.md` and `AGENTS.md` + `CLAUDE.md` from `assets/`, filled in for this product, so Epic 0 can start immediately.
|
|
154
|
+
- Wrap-up message: 5–10 lines. Point at the Assumptions table and the Open Questions, name the two or three things you are least sure about, and tell the user the next step is to open a fresh coding session and paste the Epic 0 session prompt from the document's appendix. Do not re-summarise the document.
|
|
155
|
+
|
|
156
|
+
### Language convention
|
|
157
|
+
|
|
158
|
+
- **Chat and human-facing prose** (executive summary, research narrative, persona descriptions, rationale columns, risks): the user's language.
|
|
159
|
+
- **Machine-facing text**: English, always — epic titles, story sentences, acceptance criteria, edge cases, test names, task lists, Definition of Done, architecture, data model, API contracts, conventions, session protocol, file names, IDs. This text is pasted into or read by a coding agent; English keeps it unambiguous.
|
|
160
|
+
- **Product copy** (UX writing tables, notification/SMS/email templates): the product's language(s), with an English gloss column so the agent understands intent. Iranian users → Persian copy following the Persian pack.
|
|
161
|
+
- **Headings**: bilingual when prose is not English, e.g. `## 11. راهنمای UX Writing (UX Writing)` — the English anchor must be present.
|
|
162
|
+
- State this convention once in the document's "How to use this document" section so the reader knows why the language switches.
|
|
163
|
+
|
|
164
|
+
If the user asks for a different split (all English, all Persian), honour it, but keep IDs and code-facing identifiers in English regardless.
|
|
165
|
+
|
|
166
|
+
### Detecting the market from the message
|
|
167
|
+
|
|
168
|
+
Look for: the language of the message, currency words (تومان، ریال، IRR), Iranian cities or provinces, Iranian services (Snapp, Digikala, Shaparak, Bale, Eitaa, Rubika, Zarinpal, Kavenegar…), `.ir` domains, Jalali dates, mentions of کد ملی, or explicit "کاربر ایرانی". Any of these → treat "users are in Iran" as the working hypothesis, confirm it in intake, and if confirmed load the Iran-specific parts of the research protocol, the UX writing guide and the edge-case catalog. Apply the same logic for any other specific market the message reveals (build the equivalent localisation pack from research if no prebuilt one exists).
|
|
169
|
+
|
|
170
|
+
### Design reference handling
|
|
171
|
+
|
|
172
|
+
If the user provides a reference (Figma, URL, screenshots, brand kit): extract tokens and patterns from it and document them as the design direction, noting where you deviate for usability or RTL. If not: choose a direction yourself — mobile-first, minimal, standard components, a well-documented design system verified via search — and say so in the Decision brief so they can object once. Never leave design "to be decided later"; the build sessions need concrete tokens and component decisions.
|
|
173
|
+
|
|
174
|
+
### Guardrails that override everything else
|
|
175
|
+
|
|
176
|
+
- If the idea involves strangers interacting, user-generated media, minors, payments, health or money advice: baseline safety (report/block/rate-limit, consent, audit) ships inside the same epic as the core loop, never as a later "nice to have". Say so in that epic's rationale.
|
|
177
|
+
- Legal, tax and regulatory matters are flagged as Open Questions for a professional, never answered.
|
|
178
|
+
- Keep moderation and abuse-prevention specs at the level of *what the system does*; never write bypass logic or filter word-lists.
|
|
179
|
+
- Never fabricate a source, a version number, a competitor feature or a metric. `[UNKNOWN]` is always an acceptable answer; a confident wrong answer never is.
|
|
180
|
+
|
|
181
|
+
## Examples
|
|
182
|
+
|
|
183
|
+
### Example 1: Full product from a two-line idea
|
|
184
|
+
|
|
185
|
+
```text
|
|
186
|
+
I want a Telegram bot that helps freelancers track invoices and nudges late clients.
|
|
187
|
+
Do the research, pick the stack, write me the PRD and epics so Codex can build it one epic at a time.
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
The agent runs a short search warm-up, asks one batch of intake questions with defaults, researches and benchmarks, posts the decision brief, waits for "go", then writes the blueprint section by section and lints it.
|
|
191
|
+
|
|
192
|
+
### Example 2: Internal tool with a smaller scope
|
|
193
|
+
|
|
194
|
+
```text
|
|
195
|
+
An internal tool for our 12-person support team to tag and search customer emails from Gmail,
|
|
196
|
+
nothing fancy. Give me the full spec with acceptance criteria and tests.
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### Example 3: Iranian market (Persian prose, English machine-facing text)
|
|
200
|
+
|
|
201
|
+
```text
|
|
202
|
+
یه اپ میخوام که رستورانهای تهران بتونن منوی QR داشته باشن و مشتری از سر میز سفارش بده و با زرینپال پرداخت کنه. برام کامل پلن کن که با Claude Code بسازم.
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
The market cues (Persian, Tehran, Zarinpal) make "users are in Iran" the working hypothesis; the agent confirms it in intake and loads the Iran-specific research, UX writing and edge-case material.
|
|
206
|
+
|
|
207
|
+
### Example 4: Lint the finished blueprint
|
|
208
|
+
|
|
209
|
+
Run from this skill's folder, pointing at the blueprint file:
|
|
210
|
+
|
|
211
|
+
```bash
|
|
212
|
+
python3 scripts/lint_blueprint.py docs/BLUEPRINT.md
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
Exit code 0 means no errors (warnings may remain); add `--strict` to fail on warnings as well.
|
|
216
|
+
|
|
217
|
+
## Best Practices
|
|
218
|
+
|
|
219
|
+
- ✅ Ask one batch of intake questions with a default next to each, then wait for the answers.
|
|
220
|
+
- ✅ Tag every external claim `[VERIFIED — source, date]`, `[ASSUMED — why]` or `[UNKNOWN → OQ-nn]`.
|
|
221
|
+
- ✅ Derive the architecture drivers before choosing the stack, and name what each rejected option would have bought.
|
|
222
|
+
- ✅ Write the document in chunks, one major section per write, and run the linter before delivering.
|
|
223
|
+
- ❌ Don't skip the decision brief checkpoint before writing a long document.
|
|
224
|
+
- ❌ Don't fill a research gap with a plausible guess; route it to Open Questions.
|
|
225
|
+
|
|
226
|
+
## Limitations
|
|
227
|
+
|
|
228
|
+
- Needs web search to meet its no-hallucination bar. Without web access the blueprint is delivered with every external fact marked `[UNVERIFIED]` and a warning on the cover.
|
|
229
|
+
- A whole product typically takes 20–60 searches and a long writing phase, so it is slow and token-heavy compared with a quick PRD.
|
|
230
|
+
- Legal, tax and regulatory questions are flagged as Open Questions for a professional, never answered.
|
|
231
|
+
- The prebuilt localisation pack covers Iran; other markets get their localisation built from research during the run.
|
|
232
|
+
- `scripts/lint_blueprint.py` checks structure and cross-references, not whether the research is correct; the human read-through in Phase 4 is still required.
|
|
233
|
+
- The skill plans the build; the code is written later in separate coding sessions that follow the blueprint.
|
|
234
|
+
|
|
235
|
+
## Security & Safety Notes
|
|
236
|
+
|
|
237
|
+
- The only command the skill runs is the bundled linter, `python3 scripts/lint_blueprint.py <blueprint.md>`. It uses the Python standard library, reads the one file it is given, prints findings and makes no network calls.
|
|
238
|
+
- Web research uses the harness's own search and fetch tools; the skill needs no API keys or credentials. Search queries describe the idea, so ask before searching for details the user marks as confidential.
|
|
239
|
+
- It creates Markdown files only: the blueprint, and in Claude Code / Codex also `docs/PROGRESS.md`, `docs/DECISIONS.md`, `AGENTS.md` and `CLAUDE.md`. If any of these already exist, show the proposed changes and merge them with the user's approval instead of overwriting.
|
|
240
|
+
- It does not delete files, install packages, push, or deploy.
|
|
241
|
+
|
|
242
|
+
## Common Pitfalls
|
|
243
|
+
|
|
244
|
+
- **Problem:** The stack is chosen first and the architecture drivers are written to justify it.
|
|
245
|
+
**Solution:** Run research track C (drivers and shape) before D (stack), and check that at least one driver could have changed the technology choice.
|
|
246
|
+
- **Problem:** A hundred-page document written in one output gets truncated or rushed.
|
|
247
|
+
**Solution:** Create the file with the cover and table of contents, then append one major section per write.
|
|
248
|
+
- **Problem:** "Use X or Y" leaves the decision to a build session with less context.
|
|
249
|
+
**Solution:** Decide, record the alternatives, and state why they lost.
|
|
250
|
+
|
|
251
|
+
## Related Skills
|
|
252
|
+
|
|
253
|
+
- `@spec-driven-development` - Lighter spec-before-code workflow when deep research and benchmarking are not needed.
|
|
254
|
+
- `@to-prd` - Turns an existing conversation into a PRD without an interview or research phase.
|
|
255
|
+
- `@planning-and-task-breakdown` - Breaks an existing spec into ordered implementation tasks.
|
|
256
|
+
- `@brainstorming` - Explore and shape the idea before committing to a blueprint.
|
|
257
|
+
|
|
258
|
+
## Additional Resources
|
|
259
|
+
|
|
260
|
+
- [idea-to-blueprint on GitHub](https://github.com/iniesohidham/idea-to-blueprint)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# {{PRODUCT_NAME}} — agent instructions
|
|
2
|
+
|
|
3
|
+
You are building this product one epic per fresh session. Nothing is remembered between sessions; the repo is the memory.
|
|
4
|
+
|
|
5
|
+
## Read in this order, every session
|
|
6
|
+
1. `docs/PROGRESS.md` — where we are, evidence, deviations, preconditions
|
|
7
|
+
2. `docs/BLUEPRINT.md` — sections 12–16 (architecture, stack, conventions, quality, edge cases, delivery plan), 18 (session protocol), 21 (glossary), and the epic you were asked to build in section 17 plus every flow/screen/copy ID it references
|
|
8
|
+
3. `docs/DECISIONS.md` — why things are the way they are
|
|
9
|
+
4. `docs/REVIEW-CHECKLIST.md` — the standard every story is reviewed against before it is DONE
|
|
10
|
+
|
|
11
|
+
## Rules
|
|
12
|
+
- Follow `docs/BLUEPRINT.md` §18 (session protocol) exactly: orient → verify preconditions → plan → build story by story with tests first → verify gates → update PROGRESS/DECISIONS → print handoff.
|
|
13
|
+
- Quality gate: `{{CHECK_COMMAND}}` must be green before every commit and at handoff. It runs format, lint, typecheck, tests and the architecture fitness functions; it must exit non-zero on any failure. **Never weaken, skip or bypass a gate rule to make a change pass** — if it must change, that is a DR entry plus a follow-up story.
|
|
14
|
+
- Self-review before handoff: walk the review checklist in `docs/REVIEW-CHECKLIST.md` (BLUEPRINT §14.4) over your own diff, story by story, reading the diff rather than your memory of writing it. Fix what fails. Report `reviewed: n items, n fixed, n accepted with reason` in the handoff — never a bare tick.
|
|
15
|
+
- Search the repo for an existing implementation before writing a new helper, mapper or utility. Duplicated logic is the most common defect in agent-written code, and you cannot see what you did not read.
|
|
16
|
+
- Every external symbol you use must trace to a pinned dependency in BLUEPRINT §13.1. If you are not certain a function, parameter or config key exists in the pinned version, check the docs — do not write it from memory.
|
|
17
|
+
- Tests assert concrete expected values and observable behaviour, never internal call sequences. A test that only checks a type, a length or that nothing threw is not a test. Each one must be seen failing before the implementation.
|
|
18
|
+
- Keep each story's diff within {{DIFF_LIMIT_LINES}} changed lines. If it will not fit, say so in the plan — the story is mis-sized and needs an amendment, not a bigger diff.
|
|
19
|
+
- Copy strings come from the copy tables (`CP-*` IDs) in the blueprint. Never improvise user-facing text.
|
|
20
|
+
- Acceptance criteria are the spec. If an AC is wrong, impossible or ambiguous: do not silently deviate — record an Amendment (BLUEPRINT §18) and, for user-visible/money/data/security changes, ask first.
|
|
21
|
+
- Anything not in the blueprint or PROGRESS.md is a decision → `docs/DECISIONS.md` (DR-nn) in the same commit. New dependency = DR entry.
|
|
22
|
+
- Stay inside the epic's scope. Ideas for later go to PROGRESS.md "Parking lot".
|
|
23
|
+
- Re-check every `[VERIFY-AT-BUILD]` item your epic depends on before relying on it; record the result.
|
|
24
|
+
- Commit format: `type(scope): message [E03-S02]`. Branch: `epic/E03` (or trunk if the blueprint says so).
|
|
25
|
+
- Never mark a story or epic DONE without an evidence line per AC in PROGRESS.md.
|
|
26
|
+
|
|
27
|
+
## Commands
|
|
28
|
+
- Quality gate: `{{CHECK_COMMAND}}`
|
|
29
|
+
- Tests only: `{{TEST_COMMAND}}`
|
|
30
|
+
- Dev server: `{{DEV_COMMAND}}`
|
|
31
|
+
- Migrate: `{{MIGRATE_COMMAND}}`
|
|
32
|
+
- Deploy staging: `{{DEPLOY_STAGING_COMMAND}}` (see BLUEPRINT §13.8)
|
|
33
|
+
|
|
34
|
+
## Conventions (summary — full text in BLUEPRINT §13)
|
|
35
|
+
- Language/runtime: {{RUNTIME_AND_VERSION}} · Framework: {{FRAMEWORK_AND_VERSION}} · DB: {{DB_AND_VERSION}}
|
|
36
|
+
- Strict typing on; no untyped escapes; typed errors; no swallowed exceptions; structured logs without PII.
|
|
37
|
+
- Tests: unit next to code / integration in `{{INTEGRATION_TEST_DIR}}` / e2e in `{{E2E_DIR}}`; factories in `{{FACTORIES_DIR}}`.
|
|
38
|
+
- Locale: {{LOCALE_RULES_ONE_LINE, e.g. "RTL, Persian digits in UI, Jalali dates in UI, UTC in storage, Toman with unit label"}}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# {{PRODUCT_NAME}} — agent instructions
|
|
2
|
+
|
|
3
|
+
You are building this product one epic per fresh session. Nothing is remembered between sessions; the repo is the memory.
|
|
4
|
+
|
|
5
|
+
## Read in this order, every session
|
|
6
|
+
1. `docs/PROGRESS.md` — where we are, evidence, deviations, preconditions
|
|
7
|
+
2. `docs/BLUEPRINT.md` — sections 12–16 (architecture, stack, conventions, quality, edge cases, delivery plan), 18 (session protocol), 21 (glossary), and the epic you were asked to build in section 17 plus every flow/screen/copy ID it references
|
|
8
|
+
3. `docs/DECISIONS.md` — why things are the way they are
|
|
9
|
+
4. `docs/REVIEW-CHECKLIST.md` — the standard every story is reviewed against before it is DONE
|
|
10
|
+
|
|
11
|
+
## Rules
|
|
12
|
+
- Follow `docs/BLUEPRINT.md` §18 (session protocol) exactly: orient → verify preconditions → plan → build story by story with tests first → verify gates → update PROGRESS/DECISIONS → print handoff.
|
|
13
|
+
- Quality gate: `{{CHECK_COMMAND}}` must be green before every commit and at handoff. It runs format, lint, typecheck, tests and the architecture fitness functions; it must exit non-zero on any failure. **Never weaken, skip or bypass a gate rule to make a change pass** — if it must change, that is a DR entry plus a follow-up story.
|
|
14
|
+
- Self-review before handoff: walk the review checklist in `docs/REVIEW-CHECKLIST.md` (BLUEPRINT §14.4) over your own diff, story by story, reading the diff rather than your memory of writing it. Fix what fails. Report `reviewed: n items, n fixed, n accepted with reason` in the handoff — never a bare tick.
|
|
15
|
+
- Search the repo for an existing implementation before writing a new helper, mapper or utility. Duplicated logic is the most common defect in agent-written code, and you cannot see what you did not read.
|
|
16
|
+
- Every external symbol you use must trace to a pinned dependency in BLUEPRINT §13.1. If you are not certain a function, parameter or config key exists in the pinned version, check the docs — do not write it from memory.
|
|
17
|
+
- Tests assert concrete expected values and observable behaviour, never internal call sequences. A test that only checks a type, a length or that nothing threw is not a test. Each one must be seen failing before the implementation.
|
|
18
|
+
- Keep each story's diff within {{DIFF_LIMIT_LINES}} changed lines. If it will not fit, say so in the plan — the story is mis-sized and needs an amendment, not a bigger diff.
|
|
19
|
+
- Copy strings come from the copy tables (`CP-*` IDs) in the blueprint. Never improvise user-facing text.
|
|
20
|
+
- Acceptance criteria are the spec. If an AC is wrong, impossible or ambiguous: do not silently deviate — record an Amendment (BLUEPRINT §18) and, for user-visible/money/data/security changes, ask first.
|
|
21
|
+
- Anything not in the blueprint or PROGRESS.md is a decision → `docs/DECISIONS.md` (DR-nn) in the same commit. New dependency = DR entry.
|
|
22
|
+
- Stay inside the epic's scope. Ideas for later go to PROGRESS.md "Parking lot".
|
|
23
|
+
- Re-check every `[VERIFY-AT-BUILD]` item your epic depends on before relying on it; record the result.
|
|
24
|
+
- Commit format: `type(scope): message [E03-S02]`. Branch: `epic/E03` (or trunk if the blueprint says so).
|
|
25
|
+
- Never mark a story or epic DONE without an evidence line per AC in PROGRESS.md.
|
|
26
|
+
|
|
27
|
+
## Commands
|
|
28
|
+
- Quality gate: `{{CHECK_COMMAND}}`
|
|
29
|
+
- Tests only: `{{TEST_COMMAND}}`
|
|
30
|
+
- Dev server: `{{DEV_COMMAND}}`
|
|
31
|
+
- Migrate: `{{MIGRATE_COMMAND}}`
|
|
32
|
+
- Deploy staging: `{{DEPLOY_STAGING_COMMAND}}` (see BLUEPRINT §13.8)
|
|
33
|
+
|
|
34
|
+
## Conventions (summary — full text in BLUEPRINT §13)
|
|
35
|
+
- Language/runtime: {{RUNTIME_AND_VERSION}} · Framework: {{FRAMEWORK_AND_VERSION}} · DB: {{DB_AND_VERSION}}
|
|
36
|
+
- Strict typing on; no untyped escapes; typed errors; no swallowed exceptions; structured logs without PII.
|
|
37
|
+
- Tests: unit next to code / integration in `{{INTEGRATION_TEST_DIR}}` / e2e in `{{E2E_DIR}}`; factories in `{{FACTORIES_DIR}}`.
|
|
38
|
+
- Locale: {{LOCALE_RULES_ONE_LINE, e.g. "RTL, Persian digits in UI, Jalali dates in UI, UTC in storage, Toman with unit label"}}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# DECISIONS — {{PRODUCT_NAME}}
|
|
2
|
+
|
|
3
|
+
> One entry per decision, newest last. Blueprint decision records are copied here in E00 so this is the single place to look.
|
|
4
|
+
> Format: context → options → decision → consequences. Keep each under 15 lines.
|
|
5
|
+
|
|
6
|
+
## DR-01 — {{Title, e.g. "Stack: <language/framework>"}}
|
|
7
|
+
- Date: {{YYYY-MM-DD}} · Epic: E00 · Source: BLUEPRINT §4 / §13
|
|
8
|
+
- Context:
|
|
9
|
+
- Options considered:
|
|
10
|
+
- Decision:
|
|
11
|
+
- Consequences / follow-ups:
|
|
12
|
+
- Evidence: [VERIFIED — S-nn, date]
|
|
13
|
+
|
|
14
|
+
## DR-02 —
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# PROGRESS — {{PRODUCT_NAME}}
|
|
2
|
+
|
|
3
|
+
> State file, not a diary. The agent reads this first in every session and updates it before handoff.
|
|
4
|
+
> Source of truth for *what* to build: `docs/BLUEPRINT.md`. For *why*: `docs/DECISIONS.md`.
|
|
5
|
+
|
|
6
|
+
## Current position
|
|
7
|
+
- Active epic: E00 — Foundation
|
|
8
|
+
- Last green `check` commit: (none yet)
|
|
9
|
+
- Staging URL: (set in E00)
|
|
10
|
+
- Blockers: none
|
|
11
|
+
|
|
12
|
+
## Epic status
|
|
13
|
+
| Epic | Title | Status | Started | Done | Notes |
|
|
14
|
+
|---|---|---|---|---|---|
|
|
15
|
+
| E00 | Foundation | NOT STARTED | | | |
|
|
16
|
+
| E01 | {{EPIC_01_TITLE}} | NOT STARTED | | | |
|
|
17
|
+
<!-- one row per epic from BLUEPRINT §16. Status values: NOT STARTED · IN PROGRESS · DONE · BLOCKED -->
|
|
18
|
+
|
|
19
|
+
## Story status and AC evidence
|
|
20
|
+
<!-- For each story: status + one evidence line per AC. Evidence = passing test name in `check`, or manual check with date and observation. -->
|
|
21
|
+
### E00
|
|
22
|
+
- E00-S01 — NOT STARTED
|
|
23
|
+
- AC-1: —
|
|
24
|
+
- AC-2: —
|
|
25
|
+
|
|
26
|
+
## VERIFY-AT-BUILD results
|
|
27
|
+
| Item | Needed by | Checked (date) | Result | Notes |
|
|
28
|
+
|---|---|---|---|---|
|
|
29
|
+
| {{e.g. INT-sms sandbox reachable}} | E02 | | | |
|
|
30
|
+
|
|
31
|
+
## Deviations and amendments
|
|
32
|
+
| # | Date | Epic/Story | What changed | Why | Amendment ID (BLUEPRINT §18) |
|
|
33
|
+
|---|---|---|---|---|---|
|
|
34
|
+
|
|
35
|
+
## Accepted risks (skipped edge cases / tests) — each needs an owner and a revisit trigger
|
|
36
|
+
| # | Story | Edge case / test | Reason | Owner | Revisit when |
|
|
37
|
+
|---|---|---|---|---|---|
|
|
38
|
+
|
|
39
|
+
## Parking lot (ideas out of scope — do NOT build)
|
|
40
|
+
-
|
|
41
|
+
|
|
42
|
+
## Preconditions for the next epic
|
|
43
|
+
- (filled by the agent at handoff: env vars, accounts, credentials, manual steps the user must do)
|
|
44
|
+
|
|
45
|
+
## Session log (one line per session)
|
|
46
|
+
| Date | Epic | Outcome | Final commit |
|
|
47
|
+
|---|---|---|---|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Session prompt template (one per epic — Appendix A of the blueprint)
|
|
2
|
+
|
|
3
|
+
Fill the placeholders per epic and paste as the FIRST message of a fresh Claude Code / Codex session opened in the repo root.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
You are starting **Epic {{EPIC_ID}} — {{EPIC_TITLE}}** of {{PRODUCT_NAME}}. This is a fresh session: you remember nothing from previous sessions. The repo is the memory.
|
|
8
|
+
|
|
9
|
+
Read, in order: `AGENTS.md` (or `CLAUDE.md`), `docs/PROGRESS.md` (all of it), then `docs/BLUEPRINT.md` sections 12, 13, 14, 15, 16, 18, 21 and **Epic {{EPIC_ID}}** in section 17, plus every flow (F-*), screen (SCR-*), copy (CP-*), entity (ENT-*), API (API-*), integration (INT-*) and edge case (EC-*) ID that epic references, and `docs/REVIEW-CHECKLIST.md`.
|
|
10
|
+
|
|
11
|
+
Then follow the session protocol in BLUEPRINT §18 exactly:
|
|
12
|
+
|
|
13
|
+
1. **Orient** — confirm preconditions: previous epics DONE in PROGRESS.md; clean `git status` on main; `{{CHECK_COMMAND}}` green; required env vars present; every `[VERIFY-AT-BUILD]` item this epic depends on re-checked and recorded. If anything fails, stop and report — do not build.
|
|
14
|
+
2. **Plan** — restate the goal and stories in ≤ 15 lines; list the tests you will write per story and the tasks; flag any AC that is ambiguous or references a missing ID (treat as a blueprint defect, do not guess). {{APPROVAL_MODE: "Wait for my 'go' before building." | "Do not wait — plan, then build without stopping unless a precondition fails or an amendment needs my approval."}}
|
|
15
|
+
3. **Build** — story by story in order: tests first (they must fail), implement, keep `{{CHECK_COMMAND}}` green, copy only from CP-* IDs, one commit per story with `[E{{EPIC_ID}}-Snn]` in the message, PROGRESS.md evidence line per AC, DR-nn in DECISIONS.md for every decision the blueprint does not make.
|
|
16
|
+
4. **Verify** — full `check`, epic-level flow tests, regression of all previous epics, CI green, staging deploy + smoke if the DoD requires it. Then **self-review**: walk `docs/REVIEW-CHECKLIST.md` (BLUEPRINT §14.4) over the epic's diff, story by story, reading the diff rather than recalling what you wrote — check correctness against each AC, module boundaries, failure paths, test meaning (would a test fail if the logic were wrong?), authorization per object, behaviour at 100x data, observability, copy IDs, and diff size. Fix what fails; do not batch it. Walk the epic's Definition of Done line by line with evidence.
|
|
17
|
+
5. **Handoff** — update PROGRESS.md (status, evidence, deviations, accepted risks, VERIFY-AT-BUILD results, next epic preconditions, session log line), DECISIONS.md, and the Amendments log if anything changed; final commit; then print the ≤ 20-line handoff summary from BLUEPRINT §18 and tell me it is safe to terminate.
|
|
18
|
+
|
|
19
|
+
Rules that override everything: never mark DONE without evidence; never improvise user-facing text; never silently change an AC; never touch scope outside this epic; never weaken the quality gate to get to green; never use an API you have not verified exists in the pinned version; when in doubt, record and ask.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
Notes for the human: set the model to the strongest available and the effort/thinking level to maximum if the tool exposes it. Terminate the session after the handoff summary, then open a new one for the next epic.
|