技能 documentation-writer
📦

documentation-writer

內容修訂 r2 高風險 ⚙️ 外部命令🌐 網路存取📁 檔案系統存取

建立清晰的專案文件

專案文件經常變得不完整、不一致，或難以維護。此技能可協助 Claude、Codex 和 Claude Code 從專案檔案草擬結構化指南、README 和參考文件。

支援: Claude Codex Code(CC)
Maintain this Skill? Claim it ⚠️ 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 module。

預期結果:

  • 一份模組 README，包含簡短概述和範圍。
  • 根據模組原始檔撰寫的類別和屬性區段。
  • 實用的使用範例和 Schema.org 參考。

正在使用「documentation-writer」。 使用新的 setup steps 更新 installation guide。

預期結果:

  • 修訂後的指南，包含先決條件、排序步驟、範例和疑難排解。
  • 盡可能保留現有標題和風格。
  • 需要驗證的指令、連結和術語檢查清單。

正在使用「documentation-writer」。 為 project command 建立文件。

預期結果:

  • 一份指令參考，包含用途、語法、選項、輸出和結束代碼。
  • 常見使用方式的範例，以及相關指令的說明。

安全審計

高風險
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.

1
已掃描檔案
568
分析行數
0
複核項目
0
已忽略的誤報

已確認的安全問題 (1)

高
SKILL.md:508-515SKILL.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.

風險因素

⚙️ 外部命令 (41)
SKILL.md:22 SKILL.md:25-55 SKILL.md:55-57 SKILL.md:57-60 SKILL.md:60-62 SKILL.md:62-74 SKILL.md:74-81 SKILL.md:81-126 SKILL.md:126-133 SKILL.md:133-151 SKILL.md:151-153 SKILL.md:153-156 SKILL.md:156-157 SKILL.md:157-162 SKILL.md:162-164 SKILL.md:164-178 SKILL.md:178-185 SKILL.md:185-195 SKILL.md:195-197 SKILL.md:197-212 SKILL.md:212-218 SKILL.md:218-226 SKILL.md:226-233 SKILL.md:233-242 SKILL.md:242-245 SKILL.md:245-254 SKILL.md:254-324 SKILL.md:324-333 SKILL.md:333-344 SKILL.md:344 SKILL.md:362-376 SKILL.md:376-380 SKILL.md:380-390 SKILL.md:390-394 SKILL.md:394-407 SKILL.md:407-411 SKILL.md:411-424 SKILL.md:424-430 SKILL.md:430-464 SKILL.md:464-468 SKILL.md:468-506
🌐 網路存取 (2)
SKILL.md:3 SKILL.md:462
📁 檔案系統存取 (1)
SKILL.md:349
審計單位: 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 評分最高
github 推薦

github-documentation-writer

Skillstore 評分 77
證據置信度 高
Skillstore 使用量 64
已更新

2026-09-09

C0ntr0lledCha0s 目前

c0ntr0lledcha0s-documentation-writer

Skillstore 評分 38
證據置信度 中
Skillstore 使用量 50
已更新

2026-09-09

Skillstore 評分

評分依據 證據置信度: 中
55
架構
85
可維護性
87
內容
69
社群
78
規範符合度

你可以打造什麼

記錄新模組

從原始檔建立模組 README，包含類別摘要、屬性細節、範例和相關連結。

更新使用者指南

修訂安裝或工作流程指南，同時保留結構、術語、範例和疑難排解區段。

建立 API 參考

將指令碼或指令細節轉換為參考文件，包含語法、選項、輸出行為和結束代碼說明。

試試這些提示

草擬模組 README 
為 person module 撰寫 README。使用現有原始檔，並包含 overview、classes、properties、examples 和 related modules。
改善指南 
使用最新步驟更新 installation guide。保留目前結構，並加入常見 setup errors 的 troubleshooting。
建立技術參考 
為 build script 建立 technical reference。說明 purpose、dependencies、parameters、outputs、examples 和 exit codes。
稽核文件品質 
審閱這些 documentation files 的 accuracy、missing prerequisites、outdated links、unclear examples 和 inconsistent terminology。回傳優先排序的修正項目。

最佳實務

  • 在要求草稿前，提供相關原始檔和目前文件。
  • 發布前審閱產生的範例和指令。
  • 要求最終檢查清單，涵蓋準確性、連結、格式和缺漏區段。

避免

  • 不要在未檢查原始來源準確性的情況下發布產生的文件。
  • 不要要求此技能編造缺漏的 API、檔案或指令行為。
  • 不要在沒有核准和脈絡的情況下執行產生或發現的 shell 指令。

常見問題

此技能可以建立哪些文件？
它可以建立模組 README、使用者指南、技術參考、API 文件和品質檢查清單。
此技能只適用於 Logseq Template Graph 嗎？
它是為該專案撰寫的，但其文件結構可調整用於類似的儲存庫。
它會讀取原始檔嗎？
是。此技能會指示代理讀取原始檔、指令碼、範本和現有文件，以確保準確性。
它可以更新現有文件嗎？
可以。它能在保留結構、風格、術語和相關參考的同時修訂指南。
它會自動執行指令嗎？
此技能建議進行指令測試，但使用者應要求在任何 shell 指令執行前取得核准。
使用者在發布前應審閱什麼？
使用者應驗證範例、指令、連結、術語、先決條件，以及重要功能的涵蓋範圍。

開發者詳細資訊

授權

MIT

Skillstore 修訂

r2

版本提示

作者未聲明版本。

儲存庫

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

引用

a39a91716eadede5f4cdefd78178fed4e837a128

維護新鮮度

2026/7/26

使用量

9 次下載 · 166 次瀏覽

檔案結構

📄 SKILL.md

C0ntr0lledCha0s 的更多技能

查看全部

相關技能

查看全部