技能 documentation-writer

📦

documentation-writer

Name: documentation-writer
Author: C0ntr0lledCha0s

内容修订 r2 高风险 ⚙️ 外部命令🌐 网络访问📁 文件系统访问

创建清晰的项目文档

项目文档常常变得不完整、不一致或难以维护。此技能可帮助 Claude、Codex 和 Claude Code 根据项目文件起草结构化指南、README 和参考资料。

支持: Claude Codex Code(CC)

⚠️ 38 差

安装前请停下并请求确认。

请审查安装计划，并在更改文件前获得用户明确同意。

使用我的智能体安装

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

智能体请求

Review the Skillstore skill "documentation-writer" from https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer.md and its manifest at https://skillstore.io/api/skills/c0ntr0lledcha0s-documentation-writer/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.

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

Agent 可读资源

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

Markdown 详情 GET /skills/c0ntr0lledcha0s-documentation-writer.md 已签名 manifest GET /api/skills/c0ntr0lledcha0s-documentation-writer/manifest 已签名 lockfile GET /api/skills/c0ntr0lledcha0s-documentation-writer/lockfile

测试它

正在使用“documentation-writer”。记录 person 模块。

预期结果:

一份模块 README，包含简短概述和范围。
基于模块源文件的类和属性部分。
实用用法示例和 Schema.org 参考。

正在使用“documentation-writer”。使用新的设置步骤更新安装指南。

预期结果:

一份修订后的指南，包含先决条件、有序步骤、示例和故障排除。
尽可能保留现有标题和风格。
一份需要验证的命令、链接和术语检查清单。

正在使用“documentation-writer”。为项目命令创建文档。

预期结果:

一份命令参考，包含用途、语法、选项、输出和退出代码。
常见用法示例以及相关命令说明。

安全审计

高风险

v9 • 2026/7/23 打开版本化报告

All 50 static findings are false positives caused by Markdown syntax, prose tokens, a documentation URL, and a relative link. A separate high-severity finding remains because the skill directs agents to run all commands without approval, sandboxing, or source-trust checks.

已扫描文件

568

分析行数

复核项

已忽略误报

已确认安全问题 (1)

高

SKILL.md:508-515 SKILL.md:531-533

Unrestricted Command Validation

The skill authorizes Bash for testing and directs the agent to run all commands before documenting. Repository commands could execute untrusted or destructive actions without approval.

The source explicitly lists Bash as a tool and says to run all commands, with no approval, sandboxing, or source-trust restriction.

风险因素

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

分享与引用此报告

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

打开版本化报告

复制报告链接

https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown 徽章

[![Skillstore security assessment](https://skillstore.io/badges/skills/c0ntr0lledcha0s-documentation-writer/security.svg)](https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer?utm_source=security_passport_badge)

HTML 徽章

<a href="https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/c0ntr0lledcha0s-documentation-writer/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

嵌入卡片

<iframe src="https://skillstore.io/embed/skills/c0ntr0lledcha0s-documentation-writer.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 引用

C0ntr0lledCha0s. (2026). documentation-writer security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9

BibTeX 引用

@techreport{c0ntr0lledcha0s-c0ntr0lledcha0s-documentation-writer-2026,
  author = {C0ntr0lledCha0s},
  title = {documentation-writer security audit report (audit version 9)},
  institution = {Skillstore},
  year = {2026},
  number = {9},
  url = {https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9},
  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: "documentation-writer security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
  - name: "C0ntr0lledCha0s"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/c0ntr0lledcha0s-documentation-writer/audits/9"
identifiers:
  - type: other
    value: "skillstore:c0ntr0lledcha0s-documentation-writer:audit:9"
    description: "Skillstore immutable audit report identifier"

比较变体

2 个可安装变体

每位作者的技能都保持为独立的可安装项。推荐变体按 Skillstore 证据排序。

为什么此变体排名第一

Skillstore 评分最高

作者 / 来源 Skillstore 评分证据置信度 Skillstore 使用量已更新

github 推荐

github-documentation-writer

Skillstore 评分 77

证据置信度高

Skillstore 使用量 61

已更新

2026-09-09

C0ntr0lledCha0s 当前

c0ntr0lledcha0s-documentation-writer

Skillstore 评分 38

证据置信度中

Skillstore 使用量 47

已更新

2026-09-09

Skillstore 评分

评分依据证据置信度: 中

架构

可维护性

内容

社区

规范符合性

你能构建什么

记录新模块

根据源文件创建模块 README，包含类摘要、属性详情、示例和相关链接。

更新用户指南

修订安装指南或工作流指南，同时保留结构、术语、示例和故障排除部分。

创建 API 参考

将脚本或命令细节转化为参考资料，包含语法、选项、输出行为和退出代码说明。

试试这些提示

起草模块 README

为 person 模块编写 README。使用现有源文件，并包含概述、类、属性、示例和相关模块。

改进指南

使用最新步骤更新安装指南。保留当前结构，并添加常见设置错误的故障排除内容。

构建技术参考

为构建脚本创建技术参考。解释用途、依赖项、参数、输出、示例和退出代码。

审查文档质量

审查这些文档文件的准确性、缺失的先决条件、过期链接、不清晰示例和不一致术语。返回按优先级排序的修复项。

最佳实践

在请求草稿前，提供相关源文件和当前文档。
发布生成的示例和命令前先进行审查。
要求提供最终检查清单，涵盖准确性、链接、格式和缺失部分。

避免

不要在未检查源文件准确性的情况下发布生成的文档。
不要要求该技能编造缺失的 API、文件或命令行为。
不要在没有批准和上下文的情况下运行生成或发现的 shell 命令。

常见问题

此技能可以创建哪些文档？

它可以创建模块 README、用户指南、技术参考、API 文档和质量检查清单。

此技能是否仅适用于 Logseq Template Graph？

它是为该项目编写的，但其文档结构可以适配到类似仓库。

它会读取源文件吗？

是。该技能会指示代理读取源文件、脚本、模板和现有文档，以确保准确性。

它可以更新现有文档吗？

可以。它可以在保留结构、风格、术语和相关参考的同时修订指南。

它会自动执行命令吗？

该技能建议进行命令测试，但用户应要求在任何 shell 命令运行前获得批准。

用户在发布前应审查什么？

用户应验证示例、命令、链接、术语、先决条件以及重要功能的覆盖情况。

开发者详情

作者

C0ntr0lledCha0s

许可证

MIT

Skillstore 修订

版本提示

作者未声明版本。

仓库

https://github.com/C0ntr0lledCha0s/logseq-template-graph/tree/main/.claude/skills/documentation-writer

引用

a39a91716eadede5f4cdefd78178fed4e837a128

维护新鲜度

2026/7/24

使用量

9 次下载 · 166 次浏览

文件结构

📄 SKILL.md