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/ENTRY.tmpl

View on GitHub
# ENTRY.md — Entry point / navigation map

> **Start here.** This is the routing card: which doc answers which question.
> Everything below is the "topic → file" table + onboarding. Other docs detail a
> single area; this is the overview, control-flow, and checklist.

## 1. What this is
<!-- One paragraph. Same intro as README — 2–4 sentences. From Phase 2 draft. -->

## 2. Navigation (which file does what)

| Area / file | Source of truth? | What's here |
|-------------|:---------------:|-------------|
| `contracts/openapi/*.yaml` | **machine truth: API** | per-module OpenAPI specs (+conformance N/N) |
| `contracts/asyncapi/events.yaml` | **machine truth: events** | event catalog |
| `<modules>/*` | implementation | the code: implementation |
| `scripts/` | generators | scaffolding / codegen, reproducibility |
| `docs/*` | narrative | ARCHITECTURE, FEATURES, SAGA, REVIEW, TEST_CASES, ... |
| `AGENT.md` | runbook | agent phases, rules, Definition of Done (L2+) |
| `DELIVERY.md` | gate | what ships, how to verify, what NOT in |

**Hierarchy of truth on conflict** → see `docs/REFERENCE.md` §2 (top wins):
_contracts > shared-typed-code > ADR-<canon> > narrative docs > prose_.

## 3. Quick start (local)
```bash
# Phase 7: copy the REAL working commands here (not a sketch).
```

## 4. How a <module> is built (if L3·microservices)
```
services/<name>/            # single template for every module
├── src/index.ts            # entry: buildApp() + bus + shutdown
├── src/...routes/          # typed routes, mirror the OpenAPI contract
├── src/...events/          # publish + subscribe (sagas, idempotency)
├── src/db/ + migrations/   # schema + SQL migrations
└── test/                   # health / contract / integration
```

## 5. Working rules (top 5–8)
- **Contract-first:** every endpoint exists in `contracts/openapi/<svc>.yaml` before any code.
- **Contracts are machine truth:** change behavior → change the contract first.
- **Events:** format `app.<svc>.<resource>.<action>` (`created|updated|deleted`); payload camelCase; version required.
- **Close a feature end-to-end** (📋→✅): full checklist in `AGENT.md` (contract → catalog → schema → migrate → routes → events → tests → doc counters → commit gate).
- **Module isolation:** no reading another module's storage.
- **Typing:** no `any`/`@ts-ignore`; timestamps ISO.

## 6. Definition of Done (from `AGENT.md` §gate)
Green: typecheck _N/N_, build _N/N_, contract _N/N_, tests _P/Q_, cross-module sagas §1–N, compose up no flips, hygiene. Commit gate — `AGENT.md`.

## 7. First-day onboarding checklist (new dev/agent)
- [ ] Read this file → `docs/ARCHITECTURE.md` → `docs/DEV_GUIDE.md`.
- [ ] Read the canonical ADR (`docs/ADR/ADR-00N.md`) + `AGENT.md` §§run.
- [ ] Bring the stack up (run a single module, see health).
- [ ] Read one contract + one module implementation.
- [ ] Run the full check set on a clean clone.
- [ ] Pick a first tracked task from `docs/BACKLOG.md` (P1/P2).

## 8. Where to read next
| Topic | Doc |
|-------|-----|
| Architecture / data flows | `docs/ARCHITECTURE.md` |
| Feature catalog | `docs/FEATURES.md` |
| Cross-module scenarios | `docs/SAGA.md` |
| Per-module status | `docs/REVIEW.md` (L2+) |
| Test cases | `docs/TEST_CASES.md` |
| Backlog | `docs/BACKLOG.md` |
| Local dev | `docs/DEV_GUIDE.md` |
| Architecture decisions | `docs/ADR/` |
| All of it, as a map | `docs/REFERENCE.md` |
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