module-readme
维护模块 README 与版本记录
代码改动后,README 与版本记录常被遗漏,文档容易与实现脱节。本技能读取真实代码与现有文档,按固定清单更新 README 和版本条目,并如实标注验证状态。
安裝前請停止並請求確認。
請審查安裝計畫,並在變更檔案前取得使用者明確同意。
使用我的智慧代理安裝
將此請求複製給你的智慧代理,其中包含權威 Skill 頁面和清單。
Review the Skillstore skill "module-readme" from https://skillstore.io/skills/zhaobolun-code-module-readme.md and its manifest at https://skillstore.io/api/skills/zhaobolun-code-module-readme/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.你的智慧代理仍應顯示其計畫,並依安全政策請求必要確認。
Agent 可讀資源
當 AI Agent、爬蟲或腳本需要乾淨脈絡、而不是讀取完整頁面時,請使用這些連結。
測試它
正在使用「module-readme」。 更新这个模块的 README
預期結果:
已完成 README 更新:补充「约束」与「调试与回归」章节,并追加一条版本记录,注明 CR 状态与验证状态。
正在使用「module-readme」。 为本次改动写版本记录
預期結果:
- 2026-09-17 | v0.4.0 | feat: 登录范围 — 新增短信登录,影响登录入口
- CR 状态:通过;验证状态:static-checked,尚未做运行时验证
正在使用「module-readme」。 检查 README 缺少哪些必含章节
預期結果:
缺少章节:运作原理、版本迭代记录。建议补齐后再复查。
安全審計
低風險This skill is a prompt-only documentation workflow that maintains module README files and version records. The single static finding is a scanner coverage gap caused by a UTF-8 BOM before the SKILL.md frontmatter, which manual review confirms is benign. No executable code, network access, secret handling, or data-exfiltration intent was found, so no user-facing security risk was identified.
已確認的安全問題 (1)
分享與引用此報告
分享版本化評估報告、中性徽章、嵌入卡片與引用。Skillstore 只報告證據,不判斷該 Skill 是否安全。
複製報告連結
https://skillstore.io/skills/zhaobolun-code-module-readme/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/zhaobolun-code-module-readme?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/zhaobolun-code-module-readme?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/zhaobolun-code-module-readme/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/zhaobolun-code-module-readme.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 引用
zhaobolun-code. (2026). module-readme security audit report (audit version 1) [Author version unspecified]. Skillstore. https://skillstore.io/skills/zhaobolun-code-module-readme/audits/1BibTeX 引用
@techreport{zhaobolun-code-zhaobolun-code-module-readme-2026,
author = {zhaobolun-code},
title = {module-readme security audit report (audit version 1)},
institution = {Skillstore},
year = {2026},
number = {1},
url = {https://skillstore.io/skills/zhaobolun-code-module-readme/audits/1},
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: "module-readme security audit report (audit version 1)"
version: "unspecified"
type: report
authors:
- name: "zhaobolun-code"
date-released: "2026-09-17"
url: "https://skillstore.io/skills/zhaobolun-code-module-readme/audits/1"
identifiers:
- type: other
value: "skillstore:zhaobolun-code-module-readme:audit:1"
description: "Skillstore immutable audit report identifier"
Skillstore 評分
評分依據 證據置信度: 中你可以打造什麼
补写模块 README
改动后为模块补齐概述、约束与调试说明。
更新版本记录
按统一格式追加版本条目,并标注 CR 与验证状态。
评审前同步文档
在代码评审前检查并更新文档,避免文档与实现脱节。
試試這些提示
请读取这个模块的真实代码和现有 README,更新 README 并追加一条版本记录。
为本次改动写一条版本记录,包含目的、影响、CR 状态和验证状态。
检查该模块 README 是否包含概述、约束、文件结构、运作原理、调试与回归说明、版本迭代记录。
先判断本轮应由本岗还是程序员一行处理 README;若需本岗,读取真实代码、现有 README 与项目上下文,只在必要时扩充结构,并同步回归索引。
最佳實務
- 先读真实代码和现有 README,再开始写。
- 能用一行版本记录说清时,不要扩充章节结构。
- 如实区分 static-checked 与 runtime-validated。
避免
- 凭文件名猜测模块行为。
- 在 CR 仍有 blocker 时写下「最终完成」。
- 复述已有的运作原理,造成文档冗余。
常見問題
这个技能会自动运行测试吗?
它会修改业务代码吗?
什么时候会触发?
支持哪些工具?
需要我提供什么?
新增回归场景时会做什么?
開發者詳細資訊
授權
MIT
Skillstore 修訂
r1
版本提示
作者未聲明版本。
引用
9be34bdd3e1cb2f1280ccd11fa00419204fc4d81
維護新鮮度
2026/9/18
使用量
0 次下載 · 0 次瀏覽
檔案結構