update-docs
安全地更新项目文档
过时的文档会拖慢评审,并造成错误的项目假设。此技能会根据代码库审计文档,在进行事实性更新的同时保留重要上下文。
使用我的智能体安装
将此请求复制给你的智能体,其中包含权威 Skill 页面和清单。
Review the Skillstore skill "update-docs" from https://skillstore.io/skills/cygnusfear-update-docs.md and its manifest at https://skillstore.io/api/skills/cygnusfear-update-docs/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.你的智能体仍应展示其计划,并按安全策略请求必要确认。
Agent 可读资源
当 AI Agent、爬虫或脚本需要干净上下文,而不是读取完整页面时,请使用这些链接。
测试它
正在使用“update-docs”。 在新的账单流程落地后更新文档。
预期结果:
- 已审查账单文档,并将其与当前流程进行比较。
- 已更新过时的路径引用,并添加缺失的设置说明。
- 保留了迁移警告,因为它解释了一个生产风险。
正在使用“update-docs”。 检查身份验证计划是否已完成。
预期结果:
- 已根据实现证据验证已完成的计划项。
- 将已实现的项目标记为完成,并将不确定的项目保留为 todo。
- 记录了已检查的文件以及每个状态决策的原因。
正在使用“update-docs”。 刷新 CLAUDE.md,同时不丢失项目约定。
预期结果:
- 在编辑前识别了约定、警告和决策理由。
- 在保留指导章节的同时更新了事实性引用。
- 在最终摘要中列出了所有保留的章节。
安全审计
安全The static findings are false positives caused by markdown code fences, inline code formatting, Mermaid examples, and prose references to documentation paths. I found no evidence of executable shell backticks, command injection, prompt injection, credential access, or data exfiltration intent in SKILL.md.
风险因素
⚙️ 外部命令 (23)
分享与引用此报告
分享版本化评估报告、中性徽章、嵌入卡片和引用。Skillstore 只报告证据,不判断该 Skill 是否安全。
复制报告链接
https://skillstore.io/skills/cygnusfear-update-docs/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/cygnusfear-update-docs?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/cygnusfear-update-docs?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/cygnusfear-update-docs/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/cygnusfear-update-docs.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 引用
Cygnusfear. (2026). update-docs security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/cygnusfear-update-docs/audits/8BibTeX 引用
@techreport{cygnusfear-cygnusfear-update-docs-2026,
author = {Cygnusfear},
title = {update-docs security audit report (audit version 8)},
institution = {Skillstore},
year = {2026},
number = {8},
url = {https://skillstore.io/skills/cygnusfear-update-docs/audits/8},
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: "update-docs security audit report (audit version 8)"
version: "unspecified"
type: report
authors:
- name: "Cygnusfear"
date-released: "2026-07-05"
url: "https://skillstore.io/skills/cygnusfear-update-docs/audits/8"
identifiers:
- type: other
value: "skillstore:cygnusfear-update-docs:audit:8"
description: "Skillstore immutable audit report identifier"
比较变体
2 个可安装变体每位作者的技能都保持为独立的可安装项。推荐变体按 Skillstore 证据排序。
为什么此变体排名第一
Skillstore 评分
评分依据 证据置信度: 高你能构建什么
准备发布文档
在发布前刷新文档,使当前功能、路径和状态说明与已实现代码保持一致。
验证实现计划
在开发完成后审查计划文件,并且只有在实现证据完整时才更新其状态。
保护项目知识
更新架构和入门文档,同时保留决策、警告和来之不易的项目指导。
试试这些提示
更新 docs 中的文档,使其与当前代码库保持一致。保留有用上下文,并总结每一项变更。
审查 .plans,并根据代码证据对每个计划进行分类。当证据不完整时,将未完成工作保留为 todo。
根据代码库审计 CLAUDE.md 和架构文档。保留决策和警告,并在更改理由说明前先询问。
在 .plans、CLAUDE.md、docs 和 .tasks 中查找文档。将其与近期代码变更进行比较,更新安全的事实性内容,记录保留决策,并生成变更摘要。
最佳实践
- 在编辑重要文档前完整阅读它们。
- 根据当前代码或 git 历史验证每一项事实性更新。
- 除非获得人工批准,否则保留理由说明、警告和历史记录。
避免
- 不要用生成的摘要替换长篇解释性章节。
- 不要在没有完整实现证据的情况下将计划标记为 done。
- 不要删除已弃用的指导,除非它明确已经过时且已获得批准。
常见问题
此技能面向哪些文档?
它会编辑源代码吗?
它如何避免删除重要上下文?
它能更新计划状态吗?
它支持 Mermaid 图表吗?
这对 Claude、Codex 和 Claude Code 有用吗?
开发者详情
作者
Cygnusfear许可证
MIT
Skillstore 修订
r1
版本提示
作者未声明版本。
引用
7e9e368dc1a370f2040369ebcd0db06d90cb48e5
维护新鲜度
2026/7/20
使用量
6 次下载 · 282 次浏览
文件结构
📄 SKILL.md