architecture-docs SKILL.md skillA
architecture-docs from qshanx/docs-governance is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add qshanx/docs-governance/architecture-docs@git:20261012.bd30f6ePins git:20261012.bd30f6e in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- qshanx/docs-governance
- Path
skills/documentation/architecture-docs/SKILL.md- Versions recorded
- 3
- Latest version
- git:20261012.bd30f6e, committed Oct 12, 2026
- First version recorded
- Oct 11, 2026
- Size
- 6,235 bytes
- Repository stars
- 218
- License
- MIT
判断项目是否需要架构文档，或生成、完善、审查 ARCHITECTURE.md 及已有架构说明。用于模块分工、状态归属、依赖关系或核心流程需要梳理时；依据项目证据记录结构，区分当前实现与已确认设计。.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 架构文档 先判断是否需要，再处理文档。目标是让接手者理解系统、判断修改影响；本 Skill 不替项目制定新的架构规范或改造代码。 ## 1. 判断是否需要 读取已有入口、架构说明和本次相关资料；有代码时核对关键入口、配置、调用与状态写入，尚未开发时核对已确认设计。 - **需要新建**：模块分工、共享状态或跨模块流程不直观，接手或修改前需要反复探索，而现有资料没有可靠说明。 - **沿用现有文档**：已有可定位的架构主记录，先检查它是否够用，缺什么补什么，不因文件名不同再建一份。 - **暂不需要**：结构简单，现有入口和代码已能说明关系；简述依据及未来需要补充的信号。 - **证据不足**：列出影响判断的未知项；不要凭目录名猜结构，也不把缺少资料直接判为“不需要”。 例如：单个脚本读表后导出结果，通常不需要；订单横跨 API、队列和库存服务，状态由谁修改说不清，就值得记录架构。 输出结论、依据和建议位置。用户只问是否需要或要求审查时保持只读；生成、完善在既有授权范围内执行。 ## 2. 写清关键关系 复用已有主记录；确需新建时可用根目录 `ARCHITECTURE.md`，参考 `templates/ARCHITECTURE.example.md`，只保留适用部分。模板中的分层和约束是示例，不是目标项目事实。 | 内容 | 写到什么程度 | |---|---| | 模块分工 | 关键模块各负责什么、真实入口在哪；不逐项登记普通目录 | | 状态归属 | 关键数据由谁保存、谁能修改、通过什么路径修改；现有多方写入如实记录，问题另列 | | 对外接口 | 调用方需要知道的接口入口和约束链接；字段、错误码留在机器契约或代码定义 | | 依赖关系 | 记录实际依赖；已确认的允许／禁止依赖单独标明，不把建议当既有规则 | | 核心流程 | 只解释不直观的主要链路；图中注明箭头含义，代码依赖与运行时数据流分开 | | 可替换实现 | 确实存在多个实现或明确替换点时再记录，不为完整而补出抽象层 | 每项关系应能追溯到代码、配置或已确认设计。未实现的设计标为计划，证据不足标未验证；现状与约定冲突时分别记录，不替任一方编造一致性。 选择理由链接到 ADR，详细接口链接到契约；从项目现有入口或 MAP 链接架构主记录。内容过长时下沉模块细节，主记录保留总览和指针。 ## 3. 模块文档与代码边界一致性 模块建档与约定维护的编排由 [module-governance](../module-governance/SKILL.md) 按用户意图选择；本 Skill 只承担架构说明和以下边界核对，纯审查不启动写入，也不定义领域词义。 ### 证据核对步骤 …
Read the whole file at its exact version.
How to install
mdr add qshanx/docs-governance/architecture-docs@sha256:129a3d2ae4c03a81The line at the top of this page pins the label git:20261012.bd30f6e, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_cnugwju4ak72eds4)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Oct 11, 2026 and Oct 12, 2026, more than one a day.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261012.bd30f6e latest | 2026-10-12 | bd30f6e | 6,235 B | A | view · diff |
| git:20261011.d6d08d8 | 2026-10-11 | d6d08d8 | 6,241 B | A | view · diff |
| git:20261011.856328d | 2026-10-11 | 856328d | 3,574 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (6235 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
qshanx/docs-governance · 218 stars · license MIT · pushed 2026-10-16 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_cnugwju4ak72eds4 GET https://markdownregistry.com/api/v1/resolve?ref=qshanx/docs-governance/architecture-docs GET https://markdownregistry.com/api/v1/blob/129a3d2ae4c03a812a8fb4ca2fc210618c84281685994b87c82ce8d8a1ed5c45
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from qshanx/docs-governance
Every file in qshanx/docs-governance