Architecture

作者 incident-io443f47164eda无许可证2 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

Answer questions about how a team builds, deploys, and runs its software — what a system is, where it runs, what it depends on, and the real names of things (cloud projects, clusters, namespaces, hostnames, buckets) — from architecture docs wherever they live. Also guides writing those docs: an interview that pins down what each system actually is before anything is written. Use when asked "how does X run", "what is Y", "where does Z live", when grounding a component before debugging it, or when asked to write or improve architecture documentation.

AI 生成的概览

依据架构文档回答团队软件资产相关问题,并指导撰写这些文档。

功能
该技能依据架构文档回答团队如何构建、部署和运行其软件的问题,例如某个系统如何运行、依赖什么,以及云项目、集群、命名空间、主机名和存储桶的真实名称。它把每个问题路由到负责该问题的架构文档,并引用文档作答,而不是依据通用知识。它还通过一次访谈来指导撰写或扩展架构文档,先厘清每个系统究竟是什么,并遵循关于系统、视图和资产服务的结构规范。
适用场景
当被问及某个系统如何运行、某个组件是什么或某物位于何处时,或在调试前需要先了解某组件时使用。它也适用于撰写或改进架构文档的请求。它不用于诊断与修复、当前运行时状态,以及产品或代码级文档。
运行要求
仅为指令,不附带脚本。它要求智能体先加载 extensions 技能以梳理资产,并读取自身的参考文件来回答问题、撰写文档,以及了解文档位置、格式和关注点。

Architecture

Architecture docs describe what systems are: where they run, what they depend on, and the real names of things. They pair with runbooks — runbooks own procedures (how to diagnose and fix a failure), architecture owns facts (what the component is in the first place) — and each side chains to the other rather than absorbing it. This skill answers estate questions (the estate: everything you run and where) from those docs, and guides writing them.

The two jobs

  • Answer — route a question ("how does X run", "what talks to Y") to the doc that owns it, across every place architecture docs can live, and answer from the doc with citations — never from general knowledge. → references/answer.md [blocked]
  • Write — author or extend architecture docs. The heart of it is an interview that resolves what system names actually mean before anything is written: the names people use are ambiguous, and boundaries are decisions the owner makes, not facts an agent infers. → references/write.md [blocked]

Before you start

Both jobs need to know which plugins exist. Load the extensions skill and have it map the estate first — which plugins are registered, where each lives, and their sync state. Come back with that map, then start the job.

Skipping it doesn't fail loudly. It just means you searched the local half of the estate and reported it as the whole.

Where this skill looks

Architecture docs live in four places, and the same system can be documented in more than one. references/where-docs-live.md [blocked] owns them: what each place is for, how to reach it, what it cannot show you, and the order to read and write in. Both jobs work from that file rather than assuming a location.

The taxonomy

Architecture docs work when they follow a small structural spec — systems are directories (one per thing responders reason about separately, regardless of repo layout), views are root files answering one cross-system question, estate services (observability, the data platform, CI) are directories whose README routes across their tools, the README is the map, and churny values are pointed at rather than copied. The spec lives in references/format.md [blocked]; a corpus may carry its own FORMAT.md, which takes precedence. references/concerns.md [blocked] catalogs the recurring concerns (deployment, database, events, …) and the questions each file answers, and references/examples/ [blocked] is a complete worked example corpus to calibrate depth against.

What this skill is not for

Diagnosis and fixes (that's the runbook that owns the failure — the runbooks skill routes to it), current runtime state (replica counts, flag values — the docs point at where those live), and product or code-level documentation (API references, user guides).

来源与署名

来源:incident-io/skills位于plugins/incident-io/skills/architecture提交443f471

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架