# Architecture Doc

> ---

- Skill: `zhaoxuya520/architecture-doc` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add zhaoxuya520/architecture-doc`
- Raw SKILL.md: https://api.skillmd.com/api/skills/zhaoxuya520/architecture-doc/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: zhaoxuya520 (https://skillmd.com/u/zhaoxuya520)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/zhaoxuya520/architecture-doc

---

---
name: architecture-doc
description: 架构文档编写时使用。适用于系统设计 / 数据流 / 决策记录（ADR）。
---

# architecture-doc

## 适用场景

- 架构文档编写时使用。适用于系统设计 / 数据流 / 决策记录（ADR）。

## 核心原则

```text
1. 读者优先（不是作者方便）
2. 可搜索 / 可导航
3. 保持更新（过期文档 = 误导）
4. 示例 > 描述
5. 图表辅助理解
```n
## 配套模板

- `templates/architecture-doc-template.md`

## 质量自检

```text
[] 读者明确
[] 结构清晰
[] 示例完整
[] 可搜索
[] 保持更新
```n
## 常见坑

1. 写完不更新
2. 没有示例
3. 太长没导航
4. 术语不一致
5. 敏感信息泄露

## 与其他 skill 的协作

```text
上游：各工作流 → 技术输入
下游：用户 / 团队 → 消费文档
```n