Skip to content

bestdeejay-design/agent-skills / skills/docs-project

docs-project

Verified

Project (engineering) documentation branch — the 'how': README, ENTRY, AGENT/DELIVERY runbooks, and docs/ (REFERENCE map, ARCHITECTURE, ADR, SAGA, TEST_CASES, DEV_GUIDE, IMPROVEMENTS, TROUBLESHOOTING, BACKLOG, REVIEW, STATUS) plus contracts/ (OpenAPI/AsyncAPI — machine truth written BEFORE code). The map rule: every doc gets a card in REFERENCE.md. Full catalog + checklist in references/project-docs.md. Triggers: 'проектная документация', 'архитектура документация', 'adr', 'engineering docs', 'документация разработчика', 'контракты openapi', 'project docs', 'инженерная документация'.

templates/project/TEST_CASES.tmpl

View on GitHub
# TEST_CASES — Behavior verification (Gherkin-style) + coverage

> **Purpose (L2+):** how correctness is proven — structured scenarios + a coverage
> matrix that maps scenarios → tests. Written in Phase 6, kept true after.

## §0 Anti-patterns (mandatory checks to always run)
- **Contract–route parity:** every route exists in `contracts/openapi/*.yaml`
  (`hasRoute()` guard). Tests must fail if a route lacks a contract entry.
- **Path on the wire:** use `:id` in code (Fastify) vs `{id}` in contract (OpenAPI) —
  mismatch breaks runtime. Guard catches it.
- **Timestamps:** `.toISOString()`, never `new Date()` (non-canonical).
- **Typing:** no `as unknown as X`, no `any`/`@ts-ignore`.

## Scenario — <Module A> · CRUD
```gherkin
Feature: <Module> CRUD
  As a client
  I want to create/read/update/delete <entity>
  So that <value>

  Scenario: create succeeds
    Given an authorized client
    When I POST /api/<module>/v1/<entity>
    Then the response is 201 and the entity has an id

  Scenario: contract conformance
    Then every route matches contracts/openapi/<svc>.yaml
```
> Coverage matrix:
> | Scenario | Test file | Green? |
> |----------|-----------|:------:|

## Scenario — Cross-module (SAGA)
```gherkin
Scenario: sagaN happy path
  Given storage and bus are up
  When <trigger event> fires
  Then <followers> run their step and the end state is <X>
```

## Scenario — E2E (L3·frontend-app)
```gherkin
Scenario: full flow
  Given an SPA is served
  When user does <X>
  Then the UI shows <Y>
```
> E2E compatibility — state the **number** of E2E tests and where (`services/frontend/test`).
> Keep it in the `docs/REFERENCE.md` drift table if inconsistent.

## Coverage matrix
| Module | Unit | Contract | Integration | Scenario (Gherkin) | Test files |
|--------|:----:|:--------:|:-----------:|:-------------------:|:----------:|
| <module> | ✅ | ✅ N/N | ⬍ (needs bus) | §Scenario | `test/*.test.ts` |

> **Rule:** coverage matrix must match the feature list in `FEATURES.md` 1:1. A
> scenario without a test is as bad as a test with no scenario.
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall