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

View on GitHub
# ARCHITECTURE.md — Overall architecture

> **Purpose:** components, communication principles, tech stack, data flows.
> Draft in Phase 2, finalize in Phase 6. When this contradicts code — code wins,
> update this file (see hierarchy of truth in `REFERENCE.md`).

## 1. High-level diagram

```
[Client / SPA] → [Gateway] → [Module A] ──event──▶ [Module B]
                                      │                │
                                     [Storage]       [Queue/Stream]
```

<!-- ASCII or Mermaid. Components + how they talk. -->

## 2. Communication principles
- **Sync:** HTTP `/{gateway}/api/<module>/v1/...` for request/response.
- **Async:** events over the bus (`<project>.<module>.<resource>.<action>`),
  at-least-once delivery.
- **Forbidden:** module A reading module B's storage directly; sync calls between
  modules where an event is the right shape.

## 3. Tech stack
<!-- From README; here with WHY each choice. Link ADRs: e.g. "see ADR-002/ADR-007". -->

## 4. Event model (if async)
- EventEnvelope: `{ id, type, version, source, time, data }`.
- Stream/subjects: `app.>`, one stream, durable consumers, DLQ.
- Idempotency: consumers keyed by `id`; duplicate events harmless.
- Full catalog: `contracts/asyncapi/events.yaml` (machine truth).

## 5. Cross-module scenarios (sagas)
<!-- Detail in docs/SAGA.md; here a one-line index + pointer. -->

## 6. Security
- AuthN/AuthZ at the gateway; per-module scoping; API keys for public mirror (if any).
- Secrets via env; no credentials in code/docs (use placeholders + `docs/DEV_GUIDE.md`).

## 7. Repository navigation
<!-- Pointer to ENTRY.md — architecture is not the map; ENTRY is. -->

## 8. Developer rules (top)
- Contract-first (Phase 3) — see `docs/ADR/ADR-007.md`-equivalent canon.
- One authoritative home per fact; update `docs/REFERENCE.md` card on any change.
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