software-architecture
创建软件架构文档
También disponible en: sickn33,Doyajin174
软件项目往往缺乏清晰的架构文档。此技能提供了使用 Mermaid 图表记录系统设计、组件关系和数据流的模板和模式。
Descargar el ZIP de la skill
Subir en Claude
Ve a Configuración → Capacidades → Skills → Subir skill
Activa y empieza a usar
Pruébalo
Usando "software-architecture". 分析这个 REST API 项目并创建架构文档
Resultado esperado:
- 创建了包含系统概述的 ARCHITECTURE.md
- C4 上下文图显示用户、API、数据库和外部服务
- 入口点表记录了 main.py、api/routes/ 和 core/
- 关键抽象表包含 Handler、Service、Repository 类
- docs/ 文件夹结构包含组件详细文档模板
Usando "software-architecture". 为新的身份验证服务创建文档
Resultado esperado:
- docs/auth.md 包含 C4 组件图
- 关键文件表包含处理器、服务和存储库文件
- 显示登录流程和验证的序列图
- 依赖项表链接到数据库和外部 OAuth 提供商
- 测试部分包含单元测试和集成测试位置
Auditoría de seguridad
SeguroPure documentation skill containing only markdown templates and guidance. All 178 static findings are false positives: markdown backticks were misidentified as Ruby shell execution, template placeholders as weak crypto, file path references as reconnaissance, and SHA-256 hashes as C2 keywords. No executable code, network calls, or external commands exist.
Factores de riesgo
⚙️ Comandos externos (99)
🌐 Acceso a red (1)
Puntuación de calidad
Lo que puedes crear
记录遗留系统架构
将现有代码库映射到清晰的架构文档,用于新人入职和知识转移
建立架构文档标准
创建模板和模式,确保团队范围内架构文档的一致性
维护活文档
在重构和结构变更期间更新架构文档
Prueba estos prompts
Analyze this codebase structure. Identify entry points, major components, and key abstractions. Create ARCHITECTURE.md with C4 Context diagram, entry points table, and links to component detail docs.
Create docs/new-component.md for the new service. Include C4 Component diagram, key files table, and data flow sequence diagram showing how it interacts with other components.
Review the changes in this PR. Update ARCHITECTURE.md to reflect new component relationships, update any affected diagrams, and verify file references in entry points table are accurate.
Document the data flow for the processing pipeline. Use a Mermaid flowchart showing stages, transformations, and error handling paths. Include sequence diagram for key interactions.
Mejores prácticas
- 初始时保持图表简单,包含 3-5 个节点,仅在能提高清晰度时添加细节
- 在所有文档中使用一致的文件路径和命名约定
- 在结构变更或重构后立即更新架构文档
Evitar
- 创建包含过多节点和关系的过于复杂的图表
- 在高层次的 C4 上下文图中包含实现细节
- 未能从主 ARCHITECTORY.md 链接组件详细文档