Agent skill

Architecture Doc

by ProgrammerAnthony in ProgrammerAnthony/Anything-Extract

指导在项目中编写、更新与使用架构文档(ARCHITECTURE.md)。在根目录维护架构文档,修改前后需阅读文档;文档关注最终结果与流程串联,不陷入实现细节。适用于新增/变更功能、重构、或需要理解系统整体时。

MITAuto-check passedDevelopment

Install Architecture Doc

skills CLI
$ npx skills add ProgrammerAnthony/Anything-Extract --skill architecture-doc -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install ProgrammerAnthony/Anything-Extract architecture-doc --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/ProgrammerAnthony/Anything-Extract.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/architecture-doc .claude/skills/architecture-doc && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
architecture-doc
GitHub stars
139
Token cost
~606 tokens
SKILL.md length
119 words
Files
2 (incl. references)
Skills in repo
13
Repo updated
First seen
Licence
MIT

At a glance

指导在项目中编写、更新与使用架构文档(ARCHITECTURE.md)。在根目录维护架构文档,修改前后需阅读文档;文档关注最终结果与流程串联,不陷入实现细节。适用于新增/变更功能、重构、或需要理解系统整体时。

  • Works in 4 steps: 修改前后必须阅读架构文档 → 关注最终结果,不关注中间流程 → 关注流程与串联,不局限于细节代码 → …
  • Development work in your project
  • SKILL.md covers 何时使用本 Skill, 架构文档的位置与命名, 核心原则 and 建议的文档结构, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Architecture Doc is an agent skill from ProgrammerAnthony/Anything-Extract. 指导在项目中编写、更新与使用架构文档(ARCHITECTURE.md)。在根目录维护架构文档,修改前后需阅读文档;文档关注最终结果与流程串联,不陷入实现细节。适用于新增/变更功能、重构、或需要理解系统整体时。

Its SKILL.md is about 610 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including reference files (for example `references/conventions.md`).

It sits in Development. It works with Mermaid. The repository describes itself as: 高效文档识别&知识库&本地启动,前后端;整合QAnything、dify等思想和源码,快速批量可靠提取文档关键信息并导出. The licence is MIT.

When your agent uses it

  • Development work in your project

Example prompts

  • “/architecture-doc”

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. 修改前后必须阅读架构文档
  2. 关注最终结果,不关注中间流程
  3. 关注流程与串联,不局限于细节代码
  4. 保持可被 AI 与人类共同消费

What it can do on your machine

Read from SKILL.md and the folder at commit f1ed557. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Architecture Doc loads about 606 tokens when it runs, and up to ~2.1k if it reads all its reference files. Until then it costs about 30 tokens; SKILL.md has 119 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~30
When it runs · the whole SKILL.md, loaded when a task matches
~606
With references · SKILL.md plus every file in references/, read only if the agent opens them
~2.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from ProgrammerAnthony/Anything-Extract at commit f1ed557, republished under its MIT licence (© ProgrammerAnthony). 119 words, ~606 tokens.

Download SKILL.mdSave it as .claude/skills/architecture-doc/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
architecture-doc
description
指导在项目中编写、更新与使用架构文档(ARCHITECTURE.md)。在根目录维护架构文档,修改前后需阅读文档;文档关注最终结果与流程串联,不陷入实现细节。适用于新增/变更功能、重构、或需要理解系统整体时。

架构文档编写与使用

本 skill 指导在项目开发中如何编写、更新以及正确使用架构文档,使 AI 与开发者能基于同一份「系统真相」进行协作。

何时使用本 Skill

  • 用户要求编写或更新架构文档
  • 开发新功能、重构、或变更设计前,需要理解现有架构
  • 完成代码/设计修改后,需要同步更新架构说明
  • 用户提到「架构」「ARCHITECTURE」「系统设计」「流程」「模块关系」等

架构文档的位置与命名

  • 路径:项目根目录下的 ARCHITECTURE.md(以当前工作区/仓库根为准)
  • 若项目根目录不存在该文件,在开始架构相关工作时应先创建该文件,再按本 skill 的规范编写内容。

核心原则

1. 修改前后必须阅读架构文档
  • 修改前:进行功能开发、重构或设计变更前,必须先阅读根目录的 ARCHITECTURE.md,理解当前系统边界、模块划分、数据流与关键接口。
  • 修改后:代码或设计变更若影响模块职责、接口、数据流或部署方式,必须在同一轮对话或任务中更新 ARCHITECTURE.md,保证文档与实现一致。
2. 关注最终结果,不关注中间流程
  • 文档描述系统对外表现和各模块的输入输出与职责,而不是「某行代码先执行再执行」。
  • 写「用户上传文档后,经解析、分段、向量化,最终可被检索」;不写「先调 A 函数再调 B 函数」。
  • 不收录「按版本/阶段的迭代历史」(如 Stage 1/2/3 Update、某日上线范围等):这类内容描述的是中间过程与历史版本,不是当前系统的最终结果。若确需保留迭代记录,应放在文档末尾的附录(如「版本迭代记录」)中,不要放在系统概述或核心模块前。
3. 关注流程与串联,不局限于细节代码
  • 强调模块间如何衔接:谁调用谁、数据从哪来到哪去、关键 API 与事件。
  • 使用流程图(如 Mermaid)、数据流说明、接口列表来体现「流程和串联」。
  • 不在架构文档中罗列具体函数名、内部变量或实现细节;若需指向代码,只到「模块/目录/职责」级别,并注明「具体文件与目录以代码仓库为准」。
4. 保持可被 AI 与人类共同消费
  • 结构清晰、小标题明确,便于检索与引用(如「§3.3 文档处理模块」)。
  • 术语一致;新增概念在首次出现时简短定义。
  • 列表与表格优先,长段落拆成要点。

建议的文档结构

可参考项目现有 ARCHITECTURE.md,按需裁剪或扩展。推荐包含:

章节内容要点
系统概述定位、功能亮点、技术栈(仅写当前最终能力,不写版本/阶段迭代历史)
系统架构高层框图(如前端 / API / 后端领域 / 存储),Mermaid 等
核心模块各模块职责、输入输出、与上下游的衔接,不写具体代码
数据模型核心表/概念、数据流(谁生谁用)、存储结构、关键关系
API 接口按领域分组的接口列表与用途,可选请求/响应要点
关键业务流程端到端流程(如初始化、上传、处理、提取),用步骤与流程描述
扩展性/抽象Provider、可插拔点、扩展新格式/新能力的入口说明
模块与职责前端/后端按路由或层的模块划分,仅职责与边界,不列文件清单

具体文件与目录以代码仓库为准;架构文档只描述「做什么、和谁连」,不维护完整文件树。

工作流:开发与架构文档的配合

  1. 接到开发/重构任务时

    • 读取项目根目录 ARCHITECTURE.md。
    • 确认变更会影响哪些章节(模块、接口、数据流、流程等)。
  2. 设计与实现时

    • 在实现中遵循文档中已写的边界与接口;若发现文档过时或错误,记录下来。
  3. 变更完成后

    • 再次打开 ARCHITECTURE.md,根据实际变更更新对应章节。
    • 若新增模块、接口或流程,在文档中补充;若删除或合并,从文档中移除或合并描述。
    • 确保流程与串联关系(含 Mermaid 图)与当前实现一致。
  4. 评审或交接时

    • 以「先读 ARCHITECTURE.md,再读代码」为推荐顺序,便于快速建立整体图景。

检查清单(更新架构文档后)

  • 修改前已阅读 ARCHITECTURE.md
  • 文档中描述的模块职责、接口与数据流与当前实现一致
  • 无新增的实现细节(如具体函数名、内部变量);仅保留「最终结果」与「流程串联」
  • 概述与核心章节未包含「按版本/阶段的迭代历史」(如 Stage 1/2/3 Update);若有迭代记录则仅放在文档末尾附录
  • 流程图与列表已随变更更新(若有)
  • 术语与章节引用一致,便于 AI 与人类检索

延伸阅读

  • 架构文档位于项目根目录,文件名为 ARCHITECTURE.md(具体路径以当前工作区为准)。
  • 更细的写作约定与反例见 references/conventions.md(若存在)。

© ProgrammerAnthony, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (references) in .agents/skills/architecture-doc of ProgrammerAnthony/Anything-Extract.

  • SKILL.md
  • references/conventions.md

Open the folder on GitHubat commit f1ed557

Compare with similar skills

Architecture Doc next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Architecture Doc compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Architecture Doc this skillProgrammerAnthony/Anything-Extract139—~606Automated safety check: PassMIT
Archify Diagramstt-a1i/archify79k—~2.9kAutomated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design44k1 repos~7.5kAutomated safety check: PassMIT
Draw.io Diagram StudioAgents365-ai/drawio-skill10k—~2.4kAutomated safety check: NotesMIT
Pretty Mermaid Rendererimxv/Pretty-mermaid-skills1.5k—~2kAutomated safety check: PassMIT
Archify Diagram BuilderUnclecheng-li/AI_Animation1.4k2 repos~4.1kAutomated safety check: PassMIT

Similar skills

  • Archify Diagrams

    tt-a1i/archify

    Creates interactive architecture, workflow, sequence, data-flow and lifecycle diagrams as standalone HTML with inline SVG, themes and image or video export.

    79k GitHub stars~2.9k tokensUpdated today
    DevelopmentAuto-check passed
  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    44k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 5 days ago
    DevelopmentAuto-check: notes
  • Pretty Mermaid Renderer

    imxv/Pretty-mermaid-skills

    Writes and renders Mermaid diagrams as themed SVG, PNG or terminal ASCII and Unicode art with a bundled Node.js CLI that needs no browser.

    1.5k GitHub stars~2k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Archify Diagram Builder

    Unclecheng-li/AI_Animation

    Builds validated architecture, workflow, sequence, data-flow and lifecycle diagrams as standalone interactive HTML from a small JSON spec, with optional motion and image export.

    1.4k GitHub starsUsed in 2 repos~4.1k tokens
    DevelopmentAuto-check passed
  • Mermaid

    WH-2099/mermaid-skill

    Generate Mermaid diagrams from user requirements. An agent skill from WH-2099/mermaid-skill.

    288 GitHub starsUsed in 4 repos~958 tokens
    DevelopmentAuto-check passed

More from ProgrammerAnthony/Anything-Extract

All 13 skills in this repo
  • Backend Code Review

    ProgrammerAnthony/Anything-Extract

    指导在项目(python项目)中队后端代码进行质量、安全、可维护性与最佳实践审查,基于既定规则清单。适用于用户请求对 backend/ 下后端文件(如 .py)进行审查、分析或改进。不用于前端文件(如 .tsx、.ts、.js)。支持待提交变更审查、代码片段审查、按文件审查。

    139 GitHub stars~791 tokensUpdated 4 mo ago
    Auto-check passed
  • Frontend Code Review

    ProgrammerAnthony/Anything-Extract

    指导在项目中对前端代码(Next.js/React/TypeScript/Tailwind 等)进行结构、可维护性、性能与一致性审查,基于既定规则清单。适用于用户请求审查 .tsx/.ts/.js/.jsx 等前端文件或前端目录下的页面与组件。不用于后端代码(如 .py)。

    139 GitHub stars~957 tokensUpdated 4 mo ago
    Auto-check passed
  • Design An Interface

    ProgrammerAnthony/Anything-Extract

    使用并行子 agent 为某个模块生成多个根本不同的接口设计。适用于用户希望设计某个 API、探索接口选项、对比模块形状(module shapes),或提到“design it twice(把它设计两遍)”。

    139 GitHub stars~448 tokensUpdated 4 mo ago
    Auto-check passed
  • TDD

    ProgrammerAnthony/Anything-Extract

    使用 RED-GREEN-重构(red-green-refactor)循环进行测试驱动开发。适用于用户希望用 TDD 构建新功能或修复 bug,提到 “red-green-refactor”,希望使用集成测试,或询问“test-first development(先写测试)”。

    139 GitHub stars~572 tokensUpdated 4 mo ago
    Auto-check passed
  • Ubiquitous Language

    ProgrammerAnthony/Anything-Extract

    从当前对话中抽取 DDD 风格的“统一语言”术语表(ubiquitous language glossary),标记歧义,并提出规范的术语选择。保存为 UBIQUITOUSLANGUAGE.md。适用于用户希望定义领域术语、构建术语表、固化用词并强化术语一致性,或提到 “domain model” / “DDD”(领域模型与 DDD)。

    139 GitHub stars~647 tokensUpdated 4 mo ago
    Auto-check passed
  • Write A Skill

    ProgrammerAnthony/Anything-Extract

    以正确的技能结构、渐进式披露与打包资源来创建新的 agent 技能。适用于用户希望创建、编写或构建新的技能. An agent skill from ProgrammerAnthony/Anything-Extract.

    139 GitHub stars~407 tokensUpdated 4 mo ago
    Auto-check passed

Works with

Categories

Questions about Architecture Doc

What does Architecture Doc do?

指导在项目中编写、更新与使用架构文档(ARCHITECTURE.md)。在根目录维护架构文档,修改前后需阅读文档;文档关注最终结果与流程串联,不陷入实现细节。适用于新增/变更功能、重构、或需要理解系统整体时。. Architecture Doc is an agent skill from ProgrammerAnthony/Anything-Extract.

When should I use Architecture Doc?

Architecture Doc fits situations like: development work in your project.

How do I install Architecture Doc in Claude Code?

Run `npx skills add ProgrammerAnthony/Anything-Extract --skill architecture-doc -a claude-code`. Or copy the skill folder (.agents/skills/architecture-doc in ProgrammerAnthony/Anything-Extract) into .claude/skills/architecture-doc in your project. Claude Code loads it when a task matches its description.

How do I install Architecture Doc in Codex?

Run `npx skills add ProgrammerAnthony/Anything-Extract --skill architecture-doc -a codex`. Or copy the skill folder (.agents/skills/architecture-doc in ProgrammerAnthony/Anything-Extract) into .agents/skills/architecture-doc in your project. Codex loads it when a task matches its description.

Can I use Architecture Doc in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add ProgrammerAnthony/Anything-Extract --skill architecture-doc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/architecture-doc, .gemini/skills/architecture-doc, .github/skills/architecture-doc and .opencode/skills/architecture-doc in your project.

What does Architecture Doc need to run?

SKILL.md names no scripts, command-line tools or credentials: Architecture Doc is instructions for the agent only.

Does Architecture Doc access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Architecture Doc safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Architecture Doc use?

Architecture Doc is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Architecture Doc use?

About 606 tokens (SKILL.md is roughly 2.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1.5k tokens, read only when the agent opens those files.

What are the alternatives to Architecture Doc?

Skills that share tags, products or a category with Architecture Doc: Archify Diagrams (tt-a1i/archify, 79k stars), Diagram Design (cathrynlavery/diagram-design, 44k stars), Draw.io Diagram Studio (Agents365-ai/drawio-skill, 10k stars) and Pretty Mermaid Renderer (imxv/Pretty-mermaid-skills, 1.5k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Architecture Doc?

ProgrammerAnthony (a GitHub user) maintains it in ProgrammerAnthony/Anything-Extract, which has 139 GitHub stars. The repository holds 13 skills in this directory. The repository was last updated on May 13, 2026.

Source: ProgrammerAnthony/Anything-Extract on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.