跳到正文
cccskills
免费在 GitHub 公开

architecture-foundation

Design architecture foundations before implementation. Use when asked to design or refactor architecture, choose Rust/Go crate, package, module, runtime, workflow, or service boundaries, compare mature project architecture, prevent stacked one-off PRs, audit migration debt in existing repos, or produce a spec before coding.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(5)

  • SKILL.md8.9 KB
  • agents/openai.yaml243 B
  • references/go-architecture-patterns.md17.2 KB
  • references/rust-architecture-patterns.md20.4 KB
  • references/spec-template.md2.4 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Architecture Foundation

Overview

Use this skill to turn an architecture discussion into explicit boundaries, contracts, validation gates, and a small execution plan. The goal is not to copy an admired project, but to identify the project's shape and choose the minimum architecture that keeps ownership, effects, errors, and tests clear. For large existing repos, first explain the architecture they already have, then decide whether the work is boundary creation, boundary completion, or boundary deletion.

When To Use

  • The user asks "what architecture should this use?", "is this stacked work?", "make a complete spec", "design the runtime", or "compare good libraries".
  • The change touches runtime, state ownership, adapters, plugins, event loops, rendering, schedulers, persistence, or cross-module contracts.
  • A repo has many issues/PRs that look individually valid but may not converge on one architecture.
  • A mature repo has duplicated paths, compatibility shims, generated configs, workflow definitions, or docs that may disagree about the source of truth.
  • A new skill, framework, library, or large feature needs a foundation guide before implementation.

Do not use this for small, local fixes where the existing architecture is obvious and no boundary decision is needed.

Workflow

  1. Search first.
  • Inspect existing architecture docs, entrypoints, manifests, module trees, public APIs, open issues/PRs, and tests before proposing new structure.
  • If the user names a reference project, verify current source or official docs before treating it as evidence.
  • For existing repos, also inspect generated/config artifacts, migration files, background workers, cron jobs, adapters, and the largest files/tests.
  1. Classify the project shape.
  • Simple library: stable API plus internal implementation.
  • CLI or developer tool: command layer, core operations, IO adapters, reporter.
  • API gateway or model router: transport, auth/accounting, routing policy, provider adapters, billing/settlement, observability.
  • Long-running runtime: state root, scheduler, drivers, observability, shutdown.
  • Lifecycle/composition framework: dependency graph, construction phase, runtime hooks, rollback, shutdown, and test harness.
  • Event/cache/reconcile controller: watch/list input, cache/projection, queue/backpressure, worker/reconciler, retry, and drain.
  • Config/module platform: canonical config, adapters, module lifecycle, reload order, rollback, cleanup, and plugin host interfaces.
  • UI or app shell: state ownership, event protocol, renderer/platform boundary, headless tests.
  • Service framework: domain core, application services, transport, storage, middleware, error-to-response boundary.
  • Agent or workflow system: task model, scheduler, provider adapters, event log, replay/test harness.
  1. Choose one primary state ownership model.
  • App-owned entities and handles for native UI/editor runtimes.
  • State plus typed message for enumerated UI/application workflows.
  • Virtual DOM/signals when renderer portability and declarative UI dominate.
  • Typed state or service-instance state for services and middleware.
  • Event log plus projection/outbox for workflows, billing, async jobs, and reconciliation systems.
  • World/resource/system model only when data-parallel ECS is a product fit.
  • Snapshot database or input facts for incremental analysis tools.
  • Streaming pipeline for one-shot CLI tools and batch processors.
  1. Draw the foundation boundaries.
  • product/app: entrypoints, user workflows, product-specific orchestration.
  • core/domain: pure models, invariants, decisions, typed errors, no IO.
  • runtime/application: lifecycle, scheduling, event dispatch, state mutation.
  • adapters/backends: OS, renderer, provider, filesystem, network, database.
  • plugins/components: optional capabilities behind explicit contracts.
  • testing/headless: deterministic drivers, fake adapters, contract tests.
  1. Audit existing boundary health before adding tasks.
  • Name the current source of truth for each contract: code, database table, SQL seed, JSON/YAML config, generated docs, or external provider contract.
  • Mark duplicated paths as intentional bridge, legacy compatibility, or accidental fork; require an exit condition for compatibility paths.
  • Prefer a convergence/deletion plan over a new abstraction when the existing architecture is directionally correct but half migrated.
  • Treat generated files and docs as consumers unless the repo explicitly makes them authoritative.
  1. Write the contracts before tasks.
  • Ownership: who owns state, handles, resources, caches, and mutation rights.
  • Lifecycle: init, ready, run/tick/frame/request, shutdown, cleanup.
  • Effect contract: which layer may persist, call providers, bill, publish messages, mutate projections, or only emit effects for another layer.
  • Event/action: how external events become typed commands/messages/actions.
  • Effects: which layer may touch IO, processes, network, OS handles, GPU, DOM, databases, or providers.
  • Error policy: what is recoverable, user-visible, fatal, diagnostic-only, or converted at a boundary.
  • Config/resources: build-time, startup-time, runtime; owner and invalidation.
  • Observability: logs, metrics, traces, queue depth, frame/runtime telemetry.
  • Tests: unit, contract, headless, fake adapter, integration, platform/E2E.
  1. Produce a spec, not just a diagram.
  • Use references/spec-template.md when the user needs a durable artifact.
  • Include non-goals and "do not copy" notes from reference projects.
  • For every reference project, separate borrow from do_not_copy; borrow boundary contracts, not scale artifacts, global registries, generated machinery, historical migrations, or domain-specific complexity.
  • Convert the spec into P0/P1/P2 work where each task maps to one contract.
  • If issues/PRs already exist, map them to the contracts and identify gaps.

Decision Rules

  • Prefer a thin adapter around a mature runtime when the product does not need to own that runtime.
  • Split crates/modules only for stable API boundaries, side-effect isolation, compile-time isolation, independent tests, or real reuse.
  • In existing repos, do not split crates/packages first when the real problem is duplicated source-of-truth, an unfinished migration, or missing closed-loop tests.
  • Keep core free of platform handles, event loops, renderer handles, webviews, database clients, HTTP requests, process spawning, and environment reads.
  • Make hidden global state illegal unless it is deliberately modeled as typed runtime state or a scoped resource.
  • Do not let plugins become architecture escape hatches. Each plugin needs API, config/permissions when relevant, lifecycle, errors, and tests.
  • Do not accept silent degradation. Missing capability must be an explicit unsupported error, diagnostic, or blank result according to the contract.

Output Shape

For quick answers, return:

verdict:
chosen_shape:
state_owner:
boundaries:
contracts:
migration_debt:
validation:
risks:
next_steps:

For durable planning, create or update an architecture spec with:

objective
current evidence
reference models considered
chosen architecture
boundary map
source-of-truth map
contract matrix
compatibility/deletion plan
issue/PR map
validation matrix
P0/P1/P2 roadmap
open questions

Red Flags

  • A proposed module cannot say which boundary it belongs to.
  • The design names a trait/config/cache/plugin but does not wire it into startup, lifecycle, or tests.
  • Two state ownership models are mixed without an explicit bridge.
  • Two files, configs, SQL seeds, or docs claim to be the source of truth for the same product contract.
  • A compatibility shim or legacy path has no owner, test, telemetry, or removal condition.
  • Platform callbacks directly mutate core state.
  • Errors become warnings plus fallback for user-visible behavior.
  • Tests only cover the final UI/CLI and cannot drive the runtime headlessly.
  • The plan says "match X project" but cannot state what not to copy.

References

  • Read references/rust-architecture-patterns.md when designing Rust crates, runtimes, UI frameworks, app shells, schedulers, services, or developer tools.
  • Read references/go-architecture-patterns.md when designing Go modules, packages, services, ports/adapters, context-aware APIs, or concurrency flows.
  • Read references/spec-template.md when producing a repo-facing spec.
  • Use agents/openai.yaml only when a separate architecture review agent is needed for cross-checking the chosen boundaries or migration plan.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Audit and organize AI coding-agent instructions, including AGENTS.md, CLAUDE.md, skills, and agent definitions. Use when the user asks to diagnose conflicting instructions, excessive approval pauses, broad skill triggers, duplicate guidance, or broken instruction references, or to clean up that instruction set. Ordinary code review, Markdown editing, or application debugging alone does not trigger this workflow. Inspection stays read-only; apply changes when authorized.

中文简介正在准备中。当前显示原文说明。

majiayu000/spellbook2882026年10月22日 更新

Generate or update repository-specific AGENTS.md instruction files from real repo evidence. Use when asked to create, design, scaffold, split, or improve root or scoped AGENTS.md files for Codex/Claude/agent workflows, especially when a repo needs directory-specific rules, validation commands, generated-file boundaries, or a short agent onboarding router.

中文简介正在准备中。当前显示原文说明。

majiayu000/spellbook2882026年10月22日 更新

REST/GraphQL/gRPC API design best practices. Use when designing APIs, defining contracts, handling versioning. Covers OpenAPI 3.2, GraphQL Federation, gRPC streaming.

中文简介正在准备中。当前显示原文说明。

majiayu000/spellbook2882026年10月22日 更新

Mobile app UI design expert for iOS and Android. Use when designing app interfaces, creating design systems, ensuring accessibility, or following platform guidelines. Covers Material Design 3, Human Interface Guidelines, color theory, typography, and 2025 trends.

中文简介正在准备中。当前显示原文说明。

majiayu000/spellbook2882026年10月22日 更新

End-to-end app feature inventory and user-story testing workflow with a canonical tracker. Use when the user asks to audit every feature, derive expected behavior from code, test user journeys, or explicitly fix and retest documented UX or logistical defects.

中文简介正在准备中。当前显示原文说明。

majiayu000/spellbook2882026年10月22日 更新

Evidence-driven architecture research for understanding real systems and making technical decisions. Use when doing architecture landscape studies, source-backed system archaeology, build-vs-buy or adopt/adapt/build decisions, open-source and commercial comparisons, revisiting an earlier architecture choice, or handling requests such as 架构调研, 架构选型, 竞品架构, 技术尽调, 同类方案, 开源替代, how is X built, and what should we learn from X. Do not use for small mechanical changes, market-only discovery, or detailed design after the technology direction is already fixed.

中文简介正在准备中。当前显示原文说明。

majiayu000/spellbook2882026年10月22日 更新

查看 majiayu000 的全部技能

报告此技能的问题