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/TROUBLESHOOTING.tmpl
View on GitHub# TROUBLESHOOTING — Runtime error diagnostics (E1…En) + startup checklist
> **Purpose (L2):** "I ran it and X broke" → a numbered catalog of failures, each
> with cause + fix + how to verify. Written in Phase 8 from real failures. Grows as
> new failures are found. Each entry must be **reproducible and fixable**.
## Startup checklist (run in this order)
1. Infra up (`--profile core`).
2. Migrations applied.
3. Modules started (or `--profile all`).
4. Gateway restarted after any rebuild (`--force-recreate api-gateway`).
5. Health-check: `curl http://localhost:8080/api/health`.
## E1 — <Symbolic name, e.g. "workspace build fails">
- **Symptom:** `ERR_PNPM_WORKSPACE_PKG_NOT_FOUND` on build all services.
- **Cause:** per-service Dockerfile outside workspace context; `context` too shallow.
- **Fix:** use a shared Dockerfile at repo root + `context: ../..` + root
`.dockerignore` (see `docs/IMPROVEMENTS.md §2.1`).
- **Verify:** `docker compose --profile all build` exits 0.
## E2 — <db auth failed `28P01`>
- **Symptom:** `28P01` password auth failed from service.
- **Cause:** placeholder `***` vs real value in compose/README mismatch.
- **Fix:** align all references to the same value; check `DATABASE_URL`.
- **Verify:** service health shows `db: true`.
## E3 — <404 behind gateway>
- **Symptom:** `/api/<svc>/v1/...` returns 404 via gateway but works on the module port.
- **Cause:** `proxy_pass http://upstream/` trailing slash strips the matched
location prefix → upstream receives `/v1/...`, not `/api/<svc>/v1/...`.
- **Fix:** canonical `location /api/<svc>/v1/` + `proxy_pass` **without** URI part;
legacy aliases as `rewrite … last`. (ADR-007 §7.)
- **Verify:** `curl` the full path through gateway returns 200.
## E4 — <nginx caches stale upstream>
- **Symptom:** gateway keeps routing to a dead/old container IP.
- **Cause:** `proxy_pass http://<name>_up` with static resolver; container restarted → IP changed.
- **Fix:** dynamic resolver (e.g. `resolver 127.0.0.11 …` Docker DNS) + `set $upstream …`.
## E5 — <migrations not applied>
- **Symptom:** tables missing at runtime.
- **Fix:** run `db:migrate` before start; check schema names.
## Infra quick-check
```bash
docker compose ps # all services healthy?
docker logs <service> # NATS/storage connectivity
curl http://localhost:8080/api/health
```
> **Rule:** when you fix a NEW failure that took you >10 min — add it here. This file
> is the project's collective memory; every entry saves the next dev/agent a hunt.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 |