스킬 module-readme

📦

module-readme

Name: module-readme
Author: zhaobolun-code

콘텐츠 리비전 r1 낮은 위험

维护模块 README 与版本记录

代码改动后，README 与版本记录常被遗漏，文档容易与实现脱节。本技能读取真实代码与现有文档，按固定清单更新 README 和版本条目，并如实标注验证状态。

지원: Claude Codex Code(CC)

📊 72 적절함

Maintain this Skill? Claim it 📊 72 적절함

설치 전에 중지하고 확인을 요청하세요.

계획을 검토하고 파일을 변경하기 전에 사용자의 명시적 동의를 받으세요.

내 에이전트로 설치

이 요청을 에이전트에 복사하세요. 공식 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.

에이전트는 계속해서 계획을 표시하고 보안 정책에서 요구하는 확인을 요청해야 합니다.

에이전트가 읽기 쉬운 리소스

AI 에이전트, 크롤러, 스크립트가 전체 페이지 대신 정리된 컨텍스트만 필요할 때 이 링크를 사용하세요.

Markdown 상세 GET /skills/zhaobolun-code-module-readme.md 서명된 manifest GET /api/skills/zhaobolun-code-module-readme/manifest 서명된 lockfile GET /api/skills/zhaobolun-code-module-readme/lockfile

테스트해 보기

"module-readme" 사용 중입니다. 更新这个模块的 README

예상 결과:

已完成 README 更新：补充「约束」与「调试与回归」章节，并追加一条版本记录，注明 CR 状态与验证状态。

"module-readme" 사용 중입니다. 为本次改动写版本记录

예상 결과:

2026-09-17 | v0.4.0 | feat: 登录范围 — 新增短信登录，影响登录入口
CR 状态：通过；验证状态：static-checked，尚未做运行时验证

"module-readme" 사용 중입니다. 检查 README 缺少哪些必含章节

예상 결과:

缺少章节：运作原理、版本迭代记录。建议补齐后再复查。

보안 감사

낮은 위험

v1 • 2026. 9. 17. 버전별 보고서 열기

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)

낮음

SKILL.md:1

Unscanned file (invalid_frontmatter) — manual review required

[unscanned: invalid_frontmatter]

Force-confirmed metadata/low static finding; AI false-positive verdict rejected.

감사자: claude

이 보고서 공유 및 인용

버전이 지정된 평가 보고서, 중립 배지, 임베드 카드 및 인용을 공유하세요. Skillstore는 근거를 보고하지만 이 Skill의 안전 여부를 판단하지 않습니다.

버전별 보고서 열기

보고서 링크 복사

https://skillstore.io/skills/zhaobolun-code-module-readme/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown 배지

[![Skillstore security assessment](https://skillstore.io/badges/skills/zhaobolun-code-module-readme/security.svg)](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/1

BibTeX 인용

@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，更新 README 并追加一条版本记录。

写一条版本记录

为本次改动写一条版本记录，包含目的、影响、CR 状态和验证状态。

检查 README 必含章节

检查该模块 README 是否包含概述、约束、文件结构、运作原理、调试与回归说明、版本迭代记录。

完整文档流程

先判断本轮应由本岗还是程序员一行处理 README；若需本岗，读取真实代码、现有 README 与项目上下文，只在必要时扩充结构，并同步回归索引。

모범 사례

先读真实代码和现有 README，再开始写。
能用一行版本记录说清时，不要扩充章节结构。
如实区分 static-checked 与 runtime-validated。

피하기

凭文件名猜测模块行为。
在 CR 仍有 blocker 时写下「最终完成」。
复述已有的运作原理，造成文档冗余。

자주 묻는 질문

这个技能会自动运行测试吗？

不会。它只维护文档，运行时验证需要你另外执行。

它会修改业务代码吗？

默认不会，只维护 README 与版本记录。

什么时候会触发？

当你提到「文档」或「更新 README」时。

支持哪些工具？

支持 Claude、Codex 和 Claude Code。

需要我提供什么？

需要模块的真实代码、现有 README 和项目上下文文件。

新增回归场景时会做什么？

会同步更新项目上下文索引和回归索引文件。

개발자 세부 정보

작성자

zhaobolun-code

라이선스

MIT

Skillstore 리비전

버전 안내

작성자가 버전을 선언하지 않았습니다.

리포지토리

https://github.com/zhaobolun-code/ai-gates/tree/4d3e84b41403bba7e03148927324e7213a699629/.ai-gates/skills/module-readme

참조

9be34bdd3e1cb2f1280ccd11fa00419204fc4d81

유지보수 최신성

2026. 9. 18.

사용량

0 다운로드 · 0 조회

파일 구조

📁 agents/

📄 openai.yaml

📄 SKILL.md