docs-architect
创建系统文档
当架构知识只停留在源代码树中时,复杂代码库很难解释清楚。此技能会指导 Claude、Codex 和 Claude Code 根据真实的实现细节创建结构化技术手册。
使用我的智能体安装
将此请求复制给你的智能体,其中包含权威 Skill 页面和清单。
Review the Skillstore skill "docs-architect" from https://skillstore.io/skills/sickn33-docs-architect.md and its manifest at https://skillstore.io/api/skills/sickn33-docs-architect/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.你的智能体仍应展示其计划,并按安全策略请求必要确认。
Agent 可读资源
当 AI Agent、爬虫或脚本需要干净上下文,而不是读取完整页面时,请使用这些链接。
测试它
正在使用“docs-architect”。 一个 monorepo 需要为新的后端工程师编写入门文档。
预期结果:
- 包含服务边界和所有权说明的仓库概览。
- 从入口点到核心领域模块的阅读路径。
- 术语表、常见工作流和维护检查清单。
正在使用“docs-architect”。 一个 API 服务在评审前需要架构文档。
预期结果:
- 面向评审人员和利益相关者的执行摘要。
- 包含请求流和集成点的组件图。
- 包含依据和权衡的设计决策章节。
正在使用“docs-architect”。 一个遗留平台需要长期维护文档。
预期结果:
- 包含已知约束的当前状态架构手册。
- 用于部署和故障排查的运维指南。
- 关于数据模型、依赖项和未决问题的附录。
安全审计
安全The single static finding is a false positive: SKILL.md line 24 uses Markdown backticks around a resource path, not shell execution. The skill contains instructions only and defines no executable behavior. No prompt injection or other intent-based security issue was found.
风险因素
⚙️ 外部命令 (1)
分享与引用此报告
分享版本化评估报告、中性徽章、嵌入卡片和引用。Skillstore 只报告证据,不判断该 Skill 是否安全。
复制报告链接
https://skillstore.io/skills/sickn33-docs-architect/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/sickn33-docs-architect?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/sickn33-docs-architect?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-docs-architect/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/sickn33-docs-architect.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>学术引用 (APA · BibTeX · CFF)
APA 引用
sickn33. (2026). docs-architect security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-docs-architect/audits/5BibTeX 引用
@techreport{sickn33-sickn33-docs-architect-2026,
author = {sickn33},
title = {docs-architect security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/sickn33-docs-architect/audits/5},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "docs-architect security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "sickn33"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/sickn33-docs-architect/audits/5"
identifiers:
- type: other
value: "skillstore:sickn33-docs-architect:audit:5"
description: "Skillstore immutable audit report identifier"
Skillstore 评分
评分依据 证据置信度: 高你能构建什么
准备架构手册
将代码库审查转化为用于设计评审、规划和长期维护的结构化手册。
构建入门指南
创建循序渐进的阅读路径,帮助新工程师理解组件、数据流和运维关注点。
记录运维接口
解释 API、事件、依赖项、部署架构和平台交接的故障排查路径。
试试这些提示
为此仓库创建一个初始架构概览。识别主要组件、职责,以及适合新开发者的最佳阅读顺序。
审查代码库并起草 Markdown 文档大纲。包括架构、数据模型、集成、部署和故障排查等章节。
分析此服务并编写设计决策章节。解释选择关键模式的原因,并将论断链接到相关文件和行。
为此系统生成一份全面的技术手册。包括受众路径、组件深度解析、图表说明、运维说明和验证缺口。
最佳实践
- 在生成前提供仓库访问权限、目标受众和文档目标。
- 当文档提出实现相关论断时,要求提供文件和行引用。
- 与相关负责人一起审查生成的安全、部署和性能章节。
避免
- 将此技能用于不需要技术文档的无关写作任务。
- 在未提供代码库访问权限或项目上下文的情况下,请求确定性的架构论断。
- 未根据当前实现核对准确性就发布生成的手册。