@mohammadhprp/system-prompt 0.12.2 → 0.12.3

package/framework/skills/codenavi/references/notebook-spec.md

@@ -1,171 +0,0 @@
-# .notebook/ Specification
-
-Read this file when you need to create or update notes during the
-Debrief phase, or when you need to understand the notebook format
-during Briefing.
-
-## Structure
-
-```
-.notebook/
-├── INDEX.md          # Always read first. Compact index of all notes.
-├── auth-flow.md      # Individual note files — flat by default.
-├── error-handling.md
-└── checkout-race.md
-```
-
-Notes start flat in the root of `.notebook/`. When volume exceeds
-~15 notes, organize into subdirectories by category:
-
-```
-.notebook/
-├── INDEX.md
-├── flows/
-│   ├── auth-flow.md
-│   └── checkout-flow.md
-├── patterns/
-│   └── error-handling.md
-├── gotchas/
-│   └── checkout-race.md
-└── domain/
-    └── coupon-types.md
-```
-
-Categories:
-
-- **flows** — How things work. Integrations, sequences, data paths.
-- **patterns** — How things are done here. Conventions, recurring structures.
-- **gotchas** — Traps. Bugs, quirks, counterintuitive behavior.
-- **domain** — Business concepts. Terminology, rules, logic not obvious in code.
-
-These categories are guidelines, not rigid rules. If a note fits
-multiple categories, pick the primary one. If none fits, put it in root.
-
-## INDEX.md Format
-
-The index must be compact. One line per note. The AI reads this every
-session, so every byte counts.
-
-```markdown
-# .notebook
-> Project intelligence — read before every mission
-
-Last updated: 2026-02-22
-
-- [auth-flow](auth-flow.md) — OAuth2 + refresh rotation | flow | auth, security
-- [error-handling](error-handling.md) — Error boundaries + custom hook | pattern | react, errors
-- [checkout-race](checkout-race.md) — Race condition on cart update | gotcha | checkout, cart
-- [coupon-types](coupon-types.md) — Percentage vs fixed vs BOGO rules | domain | coupons, pricing
-```
-
-Format per line:
-
-```
-- [slug](path) — summary (max ~80 chars) | category | tags
-```
-
-Rules for INDEX.md:
-
-- Keep summaries short and scannable.
-- Tags are lowercase, comma-separated. Use them for quick grep.
-- Update `Last updated` whenever the index changes.
-- If using subdirectories, paths include the folder: `flows/auth-flow.md`.
-- Sort by most recently updated, not alphabetically.
-
-## Individual Note Format
-
-Notes are telegraphic. Think field notes, not documentation.
-
-```markdown
-# Auth Flow
-> OAuth2 with refresh token rotation
-
-Entry: `src/middleware/auth.ts:authMiddleware()` (L12)
-Flow: middleware → `services/auth/jwt.ts:verify()` → `services/user/find.ts:findById()`
-
-Refresh: `services/auth/refresh.ts:rotateToken()`
-- Single-use tokens — consumed on refresh, new pair issued
-- Stored in Redis with TTL (see `lib/redis.ts:sessionStore`)
-
-OAuth providers: `config/oauth.ts` — Google, GitHub
-- Each provider maps to `services/auth/oauth/[provider].ts`
-
-Session: Redis-backed via `lib/redis.ts` (L45-62)
-
-Updated: 2026-02-22
-```
-
-### Format principles
-
-1. **Pointers, not copies.** Always reference as:
-   - `file/path.ts:functionName()` for functions
-   - `file/path.ts` (L10-25) for specific line ranges
-   - `file/path.ts:ClassName.method()` for class methods
-   Never paste code blocks into notes. Code changes; pointers
-   can be re-checked. Pasted code becomes stale lies.
-
-2. **One concept per note.** If it needs scrolling, split it.
-   A note about auth flow should not also cover session management
-   unless they're inseparable.
-
-3. **Minimal prose.** Use fragments, arrows, dashes. Not sentences.
-   "middleware → verify JWT → load user → attach to req" is better
-   than "The middleware first verifies the JWT token, then loads
-   the user from the database, and finally attaches it to the
-   request object."
-
-4. **Always include Entry point.** Every note should have a clear
-   starting point so the reader knows where to begin exploring.
-
-5. **Always include Updated date.** So the reader knows how fresh
-   the information is.
-
-6. **No opinions, only observations.** "Uses Redux for state" not
-   "Uses Redux instead of a better solution." If something is
-   genuinely problematic, state the observable impact:
-   "Redux store has 47 top-level keys — finding relevant state
-   requires searching across 12 reducers."
-
-## Creating the .notebook/ for the First Time
-
-When `.notebook/` doesn't exist yet:
-
-1. Create the directory.
-2. Create INDEX.md with the header only:
-
-   ```markdown
-   # .notebook
-   > Project intelligence — read before every mission
-
-   Last updated: [today]
-   ```
-
-3. Do NOT do a full project analysis. Notes are created organically
-   as you work. The first notes will come from your first mission's
-   Debrief.
-
-## Updating Notes
-
-When updating an existing note:
-
-1. Read the current content.
-2. Add, modify, or remove information based on what you discovered.
-3. Update the `Updated` date at the bottom.
-4. If the summary in INDEX.md changed, update it too.
-
-When information becomes invalid (e.g., a flow changed because of
-your work), update the note immediately — stale notes are worse
-than no notes.
-
-## Token Budget
-
-The entire `.notebook/` system is designed for progressive disclosure:
-
-- **INDEX.md** is read every session (~5-50 lines). Cost: minimal.
-- **Individual notes** are read only when relevant to the current
-  mission. The AI decides which to open based on INDEX.md tags.
-- **Total cost per session:** INDEX.md + 0-3 relevant notes.
-
-If INDEX.md grows beyond 50 entries, consider archiving old notes
-into an `archive/` subdirectory and removing them from the active
-index. Archived notes are still searchable but not loaded by default.

package/framework/skills/create-adr/SKILL.md

@@ -1,429 +0,0 @@
----
-name: create-adr
-description: Creates Architecture Decision Records (ADRs) to document significant architectural choices and their rationale for future team members. Use when the user says "write an ADR", "document this decision", "record why we chose X", "add an architecture decision record", "create an ADR for", or wants to capture the reasoning behind a technical choice so the team understands it later. Do NOT use when the decision hasn't been made yet (use create-rfc instead), for implementation planning (use technical-design-doc-creator), or for general documentation.
-license: CC-BY-4.0
-metadata:
-  author: Tech Leads Club - github.com/tech-leads-club
-  version: '1.0.0'
----
-
-# ADR Creator
-
-You are an expert in creating Architecture Decision Records (ADRs) — concise, durable documents that capture the context, decision, and consequences of significant architectural choices so future team members understand *why* things are the way they are.
-
-## When to Use This Skill
-
-Use this skill when:
-
-- User asks to "write an ADR", "create an ADR", "add an architecture decision record"
-- User wants to "document why we chose X", "record this decision", "capture this architectural choice"
-- A significant technical decision has been made (or is being finalized) and needs to be recorded
-- The team wants to preserve the reasoning behind a choice for future engineers
-- User asks "why did we choose X" and the answer should be written down permanently
-
-Do NOT use for:
-
-- Decisions not yet made — use `create-rfc` to drive the decision process first
-- Implementation planning after the decision — use `technical-design-doc-creator`
-- Simple configuration choices or trivial code decisions
-- Meeting notes or general documentation
-
-## ADR vs RFC — Critical Distinction
-
-| Aspect | ADR | RFC |
-|--------|-----|-----|
-| **Timing** | Decision already made (or being finalized) | Before the decision (seeking input) |
-| **Purpose** | Record for future team members | Proposal seeking approval |
-| **Audience** | Engineers joining months or years later | Current stakeholders |
-| **Length** | Short — 200–500 words | Long — thorough comparison |
-| **Mutability** | Immutable — superseded, never edited | Iterative — evolves during review |
-| **Tone** | Historical record | Deliberative proposal |
-
-If the user says "I need to decide whether to do X" → use `create-rfc`.
-If the user says "We decided to do X, let me document it" → use this skill.
-
-## Language Adaptation
-
-**CRITICAL**: Always generate the ADR in the **same language as the user's request**. Detect the language automatically.
-
-- Keep technical terms in English when appropriate (e.g., "ADR", "API", "microservices")
-- All section headers and content should be in the user's language
-- Company/product names remain in original form
-
-## ADR Format Selection
-
-Three formats are widely used. Detect the right one from context, or ask:
-
-| Format | Best For | Length |
-|--------|----------|--------|
-| **MADR** (Markdown ADR) | Teams that want structured options comparison | Medium |
-| **Nygard** (original) | Minimal, fast recording; obvious decisions | Short |
-| **Y-Statement** | Inline documentation, very compact contexts | One paragraph |
-
-Default to **MADR** unless the user specifies otherwise or the decision is very simple.
-
----
-
-## Interactive Workflow
-
-### Step 1: Gather Context (if not provided)
-
-If the user provides minimal context, use **AskQuestion** to collect essential information:
-
-```json
-{
-  "title": "ADR Information",
-  "questions": [
-    {
-      "id": "adr_decision",
-      "prompt": "What was the decision made? (e.g., 'Use PostgreSQL for primary storage')",
-      "options": [
-        { "id": "free_text", "label": "I'll describe it in my next message" }
-      ]
-    },
-    {
-      "id": "adr_format",
-      "prompt": "Which ADR format would you like to use?",
-      "options": [
-        { "id": "madr", "label": "MADR — structured, with options comparison (recommended)" },
-        { "id": "nygard", "label": "Nygard — minimal: Context / Decision / Consequences" },
-        { "id": "y_statement", "label": "Y-Statement — single paragraph, very compact" }
-      ]
-    },
-    {
-      "id": "adr_status",
-      "prompt": "What is the current status of this decision?",
-      "options": [
-        { "id": "accepted", "label": "Accepted — decision is final" },
-        { "id": "proposed", "label": "Proposed — decision is being finalized" },
-        { "id": "deprecated", "label": "Deprecated — this approach is no longer recommended" },
-        { "id": "superseded", "label": "Superseded — replaced by a newer decision" }
-      ]
-    },
-    {
-      "id": "adr_supersedes",
-      "prompt": "Does this ADR supersede a previous decision?",
-      "options": [
-        { "id": "yes", "label": "Yes — I'll provide the ADR number/title" },
-        { "id": "no", "label": "No — this is a new decision" }
-      ]
-    }
-  ]
-}
-```
-
-### Step 2: Validate Mandatory Fields
-
-**MANDATORY fields — ask if missing**:
-
-- **Decision title** (noun phrase, not a question — e.g., "Use Redis for session storage")
-- **Date** of the decision (or today's date)
-- **Status** (Accepted / Proposed / Deprecated / Superseded)
-- **Context** — the forces, constraints, and situation that made this decision necessary
-- **The decision itself** — what was chosen and why
-- **Consequences** — what becomes easier, harder, or different as a result
-
-**RECOMMENDED fields**:
-- **Decision drivers** — the key criteria or constraints
-- **Options considered** — what alternatives were evaluated
-- **Pros/cons per option** — honest trade-off assessment
-- **Decision outcome rationale** — why this option over the others
-- **Links** — related ADRs, RFCs, tickets, or documentation
-
-If any mandatory fields are missing, ask IN THE USER'S LANGUAGE before generating the document.
-
-### Step 3: Assign ADR Number
-
-Scan the existing ADR directory for the next sequential number:
-
-1. Check if an ADR directory exists (`docs/adr/`, `docs/decisions/`, `.adr/`, or `adr/`)
-2. Find the highest existing number
-3. Assign the next number (e.g., if ADR-007 exists, this becomes ADR-008)
-4. If no directory exists, start at ADR-001 and suggest creating the directory
-
-### Step 4: Generate the ADR
-
-Generate the ADR following the format selected in Step 1.
-
-### Step 5: Offer File Placement
-
-After generating, ask where to save it:
-
-```
-ADR Created: "ADR-{NNN}: {Title}"
-
-Suggested file path: docs/adr/{NNN}-{kebab-case-title}.md
-
-Would you like me to:
-1. Save it to docs/adr/ (recommended convention)
-2. Save it to a different location
-3. Just show the content (I'll place it manually)
-```
-
----
-
-## Document Templates
-
-### MADR Format (Default)
-
-```markdown
-# ADR-{NNN}: {Title}
-
-- **Date**: YYYY-MM-DD
-- **Status**: Accepted | Proposed | Deprecated | Superseded by [ADR-NNN]({link})
-- **Deciders**: {who was involved in the decision}
-- **Tags**: {optional: architecture, security, performance, database, etc.}
-
-## Context and Problem Statement
-
-{Describe the context and the problem or question that led to this decision.
-2–4 sentences. What situation forced this choice?}
-
-## Decision Drivers
-
-- {Driver 1 — e.g., "Must support 10k concurrent users"}
-- {Driver 2 — e.g., "Team has no Go experience"}
-- {Driver 3 — e.g., "Must be deployable on-premise"}
-
-## Considered Options
-
-- {Option A}
-- {Option B}
-- {Option C — "Do nothing / status quo" when relevant}
-
-## Decision Outcome
-
-Chosen option: **"{Option A}"**, because {concise rationale tied to decision drivers}.
-
-### Positive Consequences
-
-- {Benefit 1}
-- {Benefit 2}
-
-### Negative Consequences
-
-- {Trade-off 1 — be honest}
-- {Trade-off 2}
-
-## Pros and Cons of the Options
-
-### {Option A} ✅ Chosen
-
-- ✅ {Pro 1}
-- ✅ {Pro 2}
-- ❌ {Con 1}
-
-### {Option B}
-
-- ✅ {Pro 1}
-- ❌ {Con 1}
-- ❌ {Con 2}
-
-### {Option C}
-
-- ✅ {Pro 1}
-- ❌ {Con 1}
-
-## Links
-
-- {Related ADR, RFC, ticket, or documentation}
-- Supersedes: [ADR-{NNN}: {Title}]({link}) (if applicable)
-- Superseded by: [ADR-{NNN}: {Title}]({link}) (if applicable)
-```
-
----
-
-### Nygard Format (Minimal)
-
-```markdown
-# ADR-{NNN}: {Title}
-
-## Status
-
-Accepted | Proposed | Deprecated | Superseded by ADR-{NNN}
-
-## Context
-
-{What is the situation that led to this decision?
-What forces are at play — technical, business, organizational?
-What constraints exist? 2–5 sentences.}
-
-## Decision
-
-{What did we decide to do?
-State it directly, in active voice: "We will use X" or "We decided to adopt Y."
-Include a brief rationale — why this option over the alternatives.}
-
-## Consequences
-
-{What becomes easier or better as a result?}
-{What becomes harder or worse? Be honest about trade-offs.}
-{What new concerns or constraints does this introduce?}
-```
-
----
-
-### Y-Statement Format (Compact)
-
-```markdown
-# ADR-{NNN}: {Title}
-
-**Date**: YYYY-MM-DD | **Status**: Accepted
-
-In the context of **{situation/use case}**,
-facing **{concern or constraint}**,
-we decided **{the option chosen}**,
-to achieve **{quality attribute or goal}**,
-accepting **{the downside or trade-off}**.
-
-**Deciders**: {names or roles}
-**Links**: {related ADRs, tickets}
-```
-
----
-
-## ADR Quality Checklist
-
-Before finalizing, verify:
-
-- [ ] **Title** is a noun phrase describing the decision (not a question, not a vague label)
-- [ ] **Date** is included (decisions without dates lose context quickly)
-- [ ] **Status** is set correctly — Accepted, Proposed, Deprecated, or Superseded
-- [ ] **Context** explains the *forces* that made this decision necessary, not just what was done
-- [ ] **Decision** is stated directly and tied to the context
-- [ ] **Consequences** include honest trade-offs — not just positives
-- [ ] **Options** (MADR format) include at least 2 alternatives actually considered
-- [ ] **Supersedes / superseded by** links are included when applicable
-- [ ] **File** follows naming convention: `NNN-kebab-case-title.md`
-- [ ] **Number** is sequential in the ADR directory
-
----
-
-## ADR File Naming Convention
-
-```
-docs/adr/
-├── 001-use-postgresql-for-primary-storage.md
-├── 002-adopt-event-driven-architecture.md
-├── 003-replace-jenkins-with-github-actions.md   ← supersedes ADR-001 if relevant
-└── README.md                                     ← optional index
-```
-
-- Zero-padded numbers: `001`, `002`, ... `099`, `100`
-- Kebab-case title
-- `.md` extension
-- Common directories: `docs/adr/`, `docs/decisions/`, `adr/`, `.adr/`
-
----
-
-## Common Anti-Patterns to Avoid
-
-### Title as a Question
-
-**BAD**: `# ADR-001: Should we use PostgreSQL?`
-
-**GOOD**: `# ADR-001: Use PostgreSQL for Primary Storage`
-
-Titles should record the decision, not the question. Future readers need to know *what was decided*, not what was considered.
-
----
-
-### Vague Context
-
-**BAD**:
-```
-We needed a database and chose PostgreSQL.
-```
-
-**GOOD**:
-```
-Our application requires a relational database with strong ACID guarantees.
-The team has deep PostgreSQL experience. MySQL was evaluated but lacks
-native support for JSONB columns, which our schema design requires.
-Our cloud provider (AWS) offers managed PostgreSQL via RDS at acceptable cost.
-```
-
-Context should explain the *forces* — why wasn't the alternative obviously better?
-
----
-
-### Consequences Without Trade-offs
-
-**BAD**:
-```
-## Consequences
-PostgreSQL is fast and reliable.
-```
-
-**GOOD**:
-```
-## Consequences
-- Enables JSONB columns and advanced indexing for our query patterns
-- Team expertise means fast onboarding and fewer operational surprises
-- Adds operational burden compared to a managed NoSQL service
-- Schema migrations require careful planning in a relational model
-```
-
-Honest trade-offs are what make ADRs valuable years later.
-
----
-
-### Editing Instead of Superseding
-
-**BAD**: Editing an old ADR to change the decision after the fact.
-
-**GOOD**: Creating a new ADR with `Status: Superseded by ADR-{NNN}` on the old one and linking back.
-
-ADRs are historical records. The old decision was correct *given what was known at the time*. Superseding preserves that context.
-
----
-
-### Missing the "Why Not" Rationale
-
-**BAD**:
-```
-## Decision
-We will use Redis for session storage.
-```
-
-**GOOD**:
-```
-## Decision
-We will use Redis for session storage. We considered storing sessions in PostgreSQL
-(already in our stack) but Redis's built-in TTL support and in-memory performance
-make it significantly better suited for high-frequency session reads. The operational
-cost of an additional service is justified by the simplified session expiry logic.
-```
-
-The rationale is *why this option and not the others* — not just what was chosen.
-
----
-
-## Important Notes
-
-- **ADRs are immutable** — never edit the decision. Supersede with a new ADR.
-- **Short is better** — 200–500 words is ideal. If it needs to be longer, move detail to a linked TDD or RFC.
-- **Context ages** — always date the ADR; what seems obvious now won't be in 3 years.
-- **Honest consequences** — a one-sided ADR loses credibility. Future engineers will hit the downsides regardless.
-- **Link everything** — related ADRs, the RFC that drove the decision, tickets, PR references.
-- **Language adaptation** — always write in the user's language.
-- **Number sequentially** — check the directory before assigning a number.
-
-## Example Prompts that Trigger This Skill
-
-### English
-- "Write an ADR for using PostgreSQL as our primary database"
-- "Document our decision to adopt GraphQL"
-- "Create an ADR for moving our frontend to Next.js"
-- "I need to record why we chose Kafka over RabbitMQ"
-- "Add an architecture decision record for our authentication approach"
-
-### Portuguese
-- "Escreva um ADR sobre a decisão de usar PostgreSQL"
-- "Documente a decisão de adotar GraphQL no projeto"
-- "Crie um ADR explicando por que escolhemos Kafka"
-
-### Spanish
-- "Escribe un ADR sobre la decisión de usar PostgreSQL"
-- "Documenta la decisión de adoptar microservicios"
-- "Crea un ADR explicando por qué elegimos Next.js"

package/framework/skills/create-adr/examples.md

@@ -1,35 +0,0 @@
-# Create ADR Examples
-
-## Record a finalized database decision
-
-User: "Write an ADR for using PostgreSQL as our primary database."
-
-Good agent behavior:
-
-- Detect the user's language and generate the ADR in it, keeping technical terms like "ADR" and "API" in English.
-- Gather the mandatory fields: decision title, date, status, context, decision, and consequences.
-- Scan the ADR directory for the next sequential number before assigning one.
-- Default to the MADR format with a structured comparison of the options considered.
-- Include honest trade-offs in the consequences, not just positives.
-
-## Capture a decision that supersedes an old one
-
-User: "We're replacing Jenkins with GitHub Actions. Document why."
-
-Good agent behavior:
-
-- Create a new ADR with status "Accepted" rather than editing the old one.
-- Link it as superseding the Jenkins decision, and note that the old ADR should be marked "Superseded by ADR-{NNN}".
-- Explain the forces behind the change and why the new choice wins given the current constraints.
-- Follow the file naming convention with a zero-padded sequential number.
-
-## The decision hasn't been made yet
-
-User: "I'm trying to decide whether to adopt GraphQL."
-
-Good agent behavior:
-
-- Recognize this is an RFC situation, not an ADR: the decision is not yet made.
-- Point the user to `create-rfc` to drive the decision process first.
-- Explain that ADRs record decisions that are finalized, while RFCs are proposals seeking input.
-- Offer to create the RFC instead of forcing an ADR before the decision exists.