技能 post-impl-docs

📦

post-impl-docs

Name: post-impl-docs
Author: Consiliency

内容修订 r1 安全 ⚙️ 外部命令🌐 网络访问🔑 环境变量

更新实现后的文档

代码变更常常会让 README 文件、变更日志和文档字符串过时。此技能会审查已完成的实现工作，并在用户需要准确指引的地方更新文档。

支持: Claude Codex Code(CC)

🥉 78 青铜

使用我的智能体安装

将此请求复制给你的智能体，其中包含权威 Skill 页面和清单。

智能体请求

Review the Skillstore skill "post-impl-docs" from https://skillstore.io/skills/consiliency-post-impl-docs.md and its manifest at https://skillstore.io/api/skills/consiliency-post-impl-docs/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

你的智能体仍应展示其计划，并按安全策略请求必要确认。

Agent 可读资源

当 AI Agent、爬虫或脚本需要干净上下文，而不是读取完整页面时，请使用这些链接。

Markdown 详情 GET /skills/consiliency-post-impl-docs.md 已签名 manifest GET /api/skills/consiliency-post-impl-docs/manifest 已签名 lockfile GET /api/skills/consiliency-post-impl-docs/lockfile

测试它

正在使用“post-impl-docs”。实现 diff 中添加了一个新的公开身份验证端点及示例。

预期结果:

README 会收到一条简洁的功能条目和更新后的使用指导。
CHANGELOG 会在适当章节下收到一条面向用户的功能条目。
相关文档页面和文档字符串会被检查是否存在过时的身份验证细节。

正在使用“post-impl-docs”。一个函数现在需要新的配置选项，并会抛出新的验证错误。

预期结果:

API 文档会描述新选项和默认行为。
文档字符串会包含新参数和验证错误。
示例会被更新，让用户看到当前的调用模式。

正在使用“post-impl-docs”。一次重构改变了内部结构，但没有改变面向用户的行为。

预期结果:

该技能会报告公开文档不需要变更，同时指出仍需对齐的任何文档字符串。

安全审计

安全

v10 • 2026/7/13 打开版本化报告

All 79 static findings are false positives caused by Markdown syntax, public documentation links, a placeholder credential, and exception text. The documented commands support repository inspection and documentation checks, with no hidden execution, credential access, exfiltration, or prompt injection. Users should still review generated documentation changes before committing them.

已扫描文件

1,168

分析行数

复核项

已忽略误报

风险因素

⚙️ 外部命令 (50)

🌐 网络访问 (5)

cookbook/changelog-formats.md:27 cookbook/changelog-formats.md:28 cookbook/changelog-formats.md:237 cookbook/changelog-formats.md:238 cookbook/changelog-formats.md:239

🔑 环境变量 (1)

cookbook/readme-updates.md:72

最新一次完成的静态与语义审计未检测到已确认的安全发现。这并不能证明该 Skill 没有副作用。

审计者: codex 查看审计历史 →

分享与引用此报告

分享版本化评估报告、中性徽章、嵌入卡片和引用。Skillstore 只报告证据，不判断该 Skill 是否安全。

打开版本化报告

复制报告链接

https://skillstore.io/skills/consiliency-post-impl-docs/audits/10?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown 徽章

[![Skillstore security assessment](https://skillstore.io/badges/skills/consiliency-post-impl-docs/security.svg)](https://skillstore.io/skills/consiliency-post-impl-docs?utm_source=security_passport_badge)

HTML 徽章

<a href="https://skillstore.io/skills/consiliency-post-impl-docs?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/consiliency-post-impl-docs/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

嵌入卡片

<iframe src="https://skillstore.io/embed/skills/consiliency-post-impl-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 引用

Consiliency. (2026). post-impl-docs security audit report (audit version 10) [Author version unspecified]. Skillstore. https://skillstore.io/skills/consiliency-post-impl-docs/audits/10

BibTeX 引用

@techreport{consiliency-consiliency-post-impl-docs-2026,
  author = {Consiliency},
  title = {post-impl-docs security audit report (audit version 10)},
  institution = {Skillstore},
  year = {2026},
  number = {10},
  url = {https://skillstore.io/skills/consiliency-post-impl-docs/audits/10},
  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: "post-impl-docs security audit report (audit version 10)"
version: "unspecified"
type: report
authors:
  - name: "Consiliency"
date-released: "2026-07-13"
url: "https://skillstore.io/skills/consiliency-post-impl-docs/audits/10"
identifiers:
  - type: other
    value: "skillstore:consiliency-post-impl-docs:audit:10"
    description: "Skillstore immutable audit report identifier"

Skillstore 评分

评分依据证据置信度: 高

架构

可维护性

内容

社区

规范符合性

你能构建什么

记录新功能

在添加公开功能后更新 README、变更日志和使用示例。

准备发布说明

在发布前将已完成的实现工作转化为清晰的变更日志条目。

维护 API 参考

在公开函数签名或行为发生变化后刷新文档和文档字符串。

试试这些提示

更新基础文档

审查最新的实现 diff，并且仅在面向用户的行为发生变化时更新 README 和 CHANGELOG。

刷新 API 文档

查找上一次提交中的公开 API 变更，更新 README 使用示例，并调整受影响的 docs 文件夹引用。

对齐文档字符串

审查已修改的函数和类，然后针对已变更的参数、返回值、异常和示例更新文档字符串。

准备发布文档

对所有实现变更进行分类，更新发布说明、README、docs 和文档字符串，然后总结变更内容及原因。

最佳实践

在编辑文档前审查实现 diff。
记录用户可见的行为，而不是私有实现细节。
匹配现有 README、变更日志和文档字符串的风格。

避免

为仅格式化的变更添加变更日志条目。
未检查新 API 形态就更新示例。
将内部重构记录为公开产品变更。

常见问题

此技能应在什么时候运行？

在实现工作完成后、打开拉取请求或发布之前运行它。

它会更新每个文档文件吗？

不会。它会更新与已变更的公开行为、API、示例或文档字符串相关的文件。

它能编写变更日志条目吗？

可以。它支持约定式变更日志、Keep a Changelog 和简单项目符号格式。

它会自动创建发布说明吗？

它可以起草可用于发布的条目，但维护者应在发布前审查措辞。

它能更新内联文档字符串吗？

可以。当参数、返回值、异常或行为发生变化时，它会更新文档字符串。

它会为示例运行测试吗？

它可以推荐验证步骤，但能否成功执行取决于项目设置。

开发者详情

作者

Consiliency

许可证

MIT

Skillstore 修订

版本提示

作者未声明版本。

仓库

https://github.com/Consiliency/treesitter-chunker/tree/main/.ai-dev-kit/skills/post-impl-docs

引用

635f69fb8d2f4e6330ba47a4e5a0fb239c04d110

维护新鲜度

2026/7/27

使用量

5 次下载 · 201 次浏览

文件结构

📁 cookbook/

📄 changelog-formats.md

📄 docstring-standards.md

📄 readme-updates.md

📄 SKILL.md