技能 analyzing-docs
📦

analyzing-docs

內容修訂 r2 安全 ⚙️ 外部命令

稽核文件覆蓋率

團隊在發布與交接前，需要關於文件缺口的明確證據。此技能會使用結構化稽核工作流程，審查覆蓋率、品質與優先順序。

支援: Claude Codex Code(CC)
Maintain this Skill? Claim it 🥉 78 銅級

使用我的智慧代理安裝

將此請求複製給你的智慧代理，其中包含權威 Skill 頁面和清單。

智能體請求
Review the Skillstore skill "analyzing-docs" from https://skillstore.io/skills/c0ntr0lledcha0s-analyzing-docs.md and its manifest at https://skillstore.io/api/skills/c0ntr0lledcha0s-analyzing-docs/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

你的智慧代理仍應顯示其計畫，並依安全政策請求必要確認。

Agent 可讀資源

當 AI Agent、爬蟲或腳本需要乾淨脈絡、而不是讀取完整頁面時，請使用這些連結。

Markdown 詳情 GET /skills/c0ntr0lledcha0s-analyzing-docs.md 已簽名 manifest GET /api/skills/c0ntr0lledcha0s-analyzing-docs/manifest 已簽名 lockfile GET /api/skills/c0ntr0lledcha0s-analyzing-docs/lockfile

測試它

正在使用「analyzing-docs」。 分析 TypeScript 服務在上線前的文件健康狀態。

預期結果:

  • 整體覆蓋率可接受，但匯出的 handlers 缺少參數細節。
  • README 說明了設定流程，但省略了部署和疑難排解步驟。
  • 優先修正項目是 API 參數文件、錯誤範例和架構概述。

正在使用「analyzing-docs」。 審查 Python 套件是否具備有用的使用者導向文件。

預期結果:

  • 大多數模組都有函式 docstrings，但範例偏少。
  • 準確性風險為中等，因為有幾個 signatures 與 README 不一致。
  • 先新增可執行範例，並更新過時的回傳值描述。

正在使用「analyzing-docs」。 為混合 Go 和 JavaScript 的 repository 準備文件待辦事項。

預期結果:

  • 將待辦事項分組為 public APIs、專案指南和架構筆記。
  • 從未記錄的匯出函式和缺少的入門步驟開始。
  • 使用每個類別的覆蓋率百分比和品質分數追蹤進度。

安全審計

安全
v10 • 2026/7/23 開啟版本化報告

All 13 static findings are false positives. Eleven matches are Markdown fences or fixed, read-only grep examples, while two reconnaissance matches are ordinary documentation checklist phrases.

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

風險因素

⚙️ 外部命令 (11)
SKILL.md:53-61 SKILL.md:61-93 SKILL.md:93-101 SKILL.md:101-106 SKILL.md:106-112 SKILL.md:112-115 SKILL.md:115-121 SKILL.md:121-124 SKILL.md:124-127 SKILL.md:127-131 SKILL.md:131-162
最近一次完成的靜態與語意稽核未偵測到已確認的安全發現。這並不能證明該 Skill 沒有副作用。
審計單位: codex 檢視審計紀錄 →
分享與引用此報告

分享版本化評估報告、中性徽章、嵌入卡片與引用。Skillstore 只報告證據，不判斷該 Skill 是否安全。

開啟版本化報告
安全評估

複製報告連結

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

Markdown 徽章

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

HTML 徽章

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

嵌入卡片

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

C0ntr0lledCha0s. (2026). analyzing-docs security audit report (audit version 10) [Author version unspecified]. Skillstore. https://skillstore.io/skills/c0ntr0lledcha0s-analyzing-docs/audits/10

BibTeX 引用

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

Skillstore 評分

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

你可以打造什麼

發布文件稽核

在發布前評估文件覆蓋率，並找出可能阻礙採用的缺口。

Public API 審查

檢查匯出的函式、參數、回傳值和錯誤情境是否有清楚記錄。

文件待辦規劃

在接手的專案中，優先處理缺少的指南、過時範例和不完整的 README 區段。

試試這些提示

檢查整體文件健康狀態 
分析此 repository 的文件覆蓋率與品質。摘要說明主要缺口和最高優先順序的修正項目。
審查 API 文件覆蓋率 
審查此 codebase 中的 public API documentation。檢查參數、回傳值、範例和錯誤文件。
比較文件品質面向 
為文件的完整性、準確性、清晰度和實用性評分。使用檔案層級證據解釋每個分數。
建立修復計畫 
建立按優先順序排列的文件修復計畫。依嚴重性、受影響使用者、工作量和預期影響分組議題。

最佳實務

  • 在重大發布或新人導入週期前，針對目前的 repository snapshot 執行稽核。
  • 在排定文件缺口優先順序時，要求提供檔案層級證據。
  • 同時檢視覆蓋率指標和品質分數，避免流於表面的文件目標。

避免

  • 不要將覆蓋率百分比視為文件準確或有用的證明。
  • 對於含有產生式程式碼或高度依賴 framework 的專案，不要只依賴 grep patterns。
  • 在檢查範例、設定步驟和 public API 行為之前，不要發布報告。

常見問題

此技能會分析什麼？
它會分析各種 codebases 中的文件覆蓋率、品質、完整性和常見缺口。
它可以衡量 API 文件覆蓋率嗎？
可以。它會審查 public functions、參數、回傳值、範例和錯誤文件。
它會編輯文件檔案嗎？
不會。它專注於分析與建議，而不是撰寫完整的替代文件。
直接提及哪些語言？
此技能包含 JavaScript、TypeScript、Python 和 Go 的審查 patterns。
團隊應如何使用結果？
使用報告依嚴重性、使用者影響和發布風險排定缺口優先順序。
它能保證文件準確性嗎？
不會。它提供結構化審查指引，但仍需要人工驗證。

開發者詳細資訊

授權

MIT

Skillstore 修訂

r2

版本提示

作者未聲明版本。

儲存庫

https://github.com/C0ntr0lledCha0s/claude-code-plugin-automations/tree/main/documents-manager/skills/analyzing-docs

引用

a39a91716eadede5f4cdefd78178fed4e837a128

維護新鮮度

2026/7/26

使用量

8 次下載 · 166 次瀏覽

檔案結構

📄 SKILL.md

C0ntr0lledCha0s 的更多技能

查看全部

相關技能

查看全部