mcpField
A
architecture-documentation

architecture-documentation

github.com/melodic-software开发28180 次安装今天更新
代码仓库

关于 architecture-documentation

architecture-documentation 是用于生成系统架构文档的 Skill，适合需要为不同利益相关者整理技术结构的团队。它涵盖 C4 图及部署、数据和高管摘要等文档类型，并提供生成流程与完整性检查清单。

主要功能

  1. 01生成 C4 上下文、容器和组件文档
  2. 02支持部署与数据架构文档
  3. 03按受众选择文档视角
  4. 04结合可视化插件生成图表
  5. 05提供文档完整性检查清单

适用场景

  1. 01为系统编写架构说明
  2. 02为开发者整理组件结构
  3. 03为运维人员记录部署环境
  4. 04为管理层制作技术摘要

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/melodic-software/claude-code-plugins --skill architecture-documentation

安装后在 Claude Code 中输入/architecture-documentation确认已加载。

详细介绍

架构文档

何时使用此技能

在以下情况下使用此技能：

  • 为系统生成架构文档
  • 创建 C4 图（上下文、容器、组件）
  • 针对不同利益相关者视角编写架构文档
  • 编写技术概述或执行摘要

关键词： 文档、c4、容器、上下文、组件、视角、架构描述、技术概述、执行摘要

文档类型

类型受众内容
上下文所有利益相关者系统边界、外部交互
容器技术负责人服务、数据库、主要组件
组件开发者容器的内部结构
部署运维人员基础设施、环境
数据数据架构师数据流、存储、架构
执行摘要管理层业务价值、关键决策

文档生成工作流

1. 分析代码库

生成文档前：

  1. 确定范围（单个服务、多个服务或整个系统）
  2. 查找要纳入的现有文档
  3. 定位关键架构文件（配置、部署规范）
2. 选择文档类型

根据以下因素进行选择：

  • 受众：谁会阅读此文档？
  • 目的：用于支持决策、帮助新人熟悉系统，还是满足合规要求？
  • 范围：组件、服务还是系统级别？
3. 生成文档

每种文档类型都有标准结构：

上下文文档
# System Context: [System Name]

## Overview
[1-2 paragraph description]

## Context Diagram
[C4 Context diagram - via visualization plugin]

## External Systems
| System | Description | Integration |
| --- | --- | --- |
| ... | ... | ... |

## Users/Actors
| Actor | Description | Interactions |
| --- | --- | --- |
| ... | ... | ... |
容器文档
# Container Architecture: [System Name]

## Overview
[Architecture summary]

## Container Diagram
[C4 Container diagram - via visualization plugin]

## Containers
### [Container Name]
- **Technology**: [Stack]
- **Purpose**: [Description]
- **Responsibilities**: [List]
- **Dependencies**: [List]
组件文档
# Component Architecture: [Container Name]

## Overview
[Component structure summary]

## Component Diagram
[C4 Component diagram - via visualization plugin]

## Components
### [Component Name]
- **Type**: [Service/Repository/Controller/etc.]
- **Responsibilities**: [List]
- **Interfaces**: [Public APIs]
4. 集成图表

如果可使用可视化插件：

  1. 调用 visualization:diagram-generator Agent
  2. 请求适当类型的 C4 图
  3. 在文档中嵌入生成的 Mermaid/PlantUML 代码

备用方案：如果无法使用可视化插件，请创建基于文本的架构描述，并注明可以通过可视化插件添加图表。

模板结构

所有架构文档都应包含：

  1. 标题信息：标题、版本、日期、作者
  2. 概述：1-2 段摘要
  3. 图表：可视化表示
  4. 详细信息：组件的结构化信息
  5. 决策：相关 ADR 的链接
  6. 参考资料：相关文档的链接

完整性检查清单

完成文档前，请确认：

  • 范围定义清晰
  • 已识别所有主要组件
  • 已记录外部依赖项
  • 关键决策已链接到 ADR
  • 图表与文本描述一致
  • 使用适合目标受众的语言
  • 已注明版本和日期

仓库位置

生成的文档应放置在：

/architecture/
  /viewpoints/
    context.md
    containers.md
    components/
      [container-name].md
    executive-summary.md

与其他技能的集成

  • adr-management：在文档中链接相关 ADR
  • togaf-guidance：与当前 ADM 阶段保持一致
  • zachman-analysis：确保覆盖适当的视角

版本历史

  • v1.0.0（2025-12-05）：首次发布
    • 面向 C4 图的文档生成工作流
    • 六种文档类型（上下文、容器、组件、部署、数据、执行摘要）
    • 可视化插件集成
    • 完整性检查清单

最后更新

日期： 2025-12-05 模型： claude-opus-4-5-20251101

评论

支持 Markdown