bestdeejay-design/agent-skills / skills/docs-project
docs-project
VerifiedProject (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', 'инженерная документация'.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 6.3 KB |
| readme.ru.md | markdown | 1.3 KB |
| references/project-docs.md | markdown | 4.5 KB |
| skill.json | config | 1.6 KB |
| templates/project/ADR-000.tmpl | other | 1.1 KB |
| templates/project/ARCHITECTURE.tmpl | other | 1.8 KB |
| templates/project/BACKLOG.tmpl | other | 1.2 KB |
| templates/project/DEV_GUIDE.tmpl | other | 1.9 KB |
| templates/project/ENTRY.tmpl | other | 3.4 KB |
| templates/project/IMPROVEMENTS.tmpl | other | 1.8 KB |
| templates/project/README.tmpl | other | 1.9 KB |
| templates/project/REFERENCE.tmpl | other | 4.4 KB |
| templates/project/REVIEW.tmpl | other | 1.7 KB |
| templates/project/SAGA.tmpl | other | 1.6 KB |
| templates/project/STATUS.tmpl | other | 886 B |
| templates/project/TEST_CASES.tmpl | other | 2.0 KB |
| templates/project/TROUBLESHOOTING.tmpl | other | 2.5 KB |
templates/project/DEV_GUIDE.tmpl
View on GitHub# DEV_GUIDE — Local development guide
> **Purpose (L2):** an exact, reproducible "how to set up and work" — a fresh dev (or
> agent) can bring the project up from a clean clone and debug a failure. Written in
> Phase 7 with real commands, not sketches.
## Prerequisites
- <!-- Node/PNPM/Docker versions, OS notes, anything that must be installed -->
## Quick start
```bash
# 1. Install (workspace / single package)
...
# 2. Infrastructure (DB / bus / gateway)
...
# 3. Migrations
...
# 4. Run a module locally (+ required env)
...
# 5. Health-check
...
```
## How a module / app is structured
> Copy from `docs/ARCHITECTURE.md` §"how a module is structured" + per-file bullet.
## Environment variables
| Var | Meaning | Example | Default |
|-----|---------|---------|---------|
## Add a new module / service (N steps)
1. `scripts/scaffold-<name>.mjs` (if L3) — generates skeleton.
2. Define contract first (`contracts/openapi/<name>.yaml`).
3. Write typed routes mirroring it.
4. Schema + migration.
5. Add a row to `docs/FEATURES.md` + `docs/REVIEW.md`.
6. Add a card to `docs/REFERENCE.md` + an ADR if a significant decision was made.
7. Tests: health/contract/integration. Run the full suite.
## Database: schema & migrations
- `db:migrate` command · where the SQL lives · how the schema is isolated (`<mod>_`).
## Debugging
- Logs: ```bash where via command ``` · NATS: ```commands``` · metrics/health-endpoints - Docker / Compose profiles
| Profile | What it starts | Use |
|---------|----------------|-----|
| `core` | storage+bus | local dev |
| `all` | everything | full stack |
## Testing
```bash
pnpm test # unit (vitest) — no storage
pnpm run test:contract # OpenAPI conformance
pnpm test:e2e # end-to-end (Playwright) — needs stack up
```
> Exact commands per your package manager/tooling — **verify they work** before
> committing this file. Nothing trips a new dev like dead instructions.Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| 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: 471k | Updated | Claude CodeCodex | Verified | Install |
| 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: 198k | Updated | Claude CodeCodex | Verified | Install |
| 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: 198k | Updated | Claude CodeCodex | Unverified | Install |
| 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: 198k | Updated | Claude CodeCodex | Verified | Install |