Skills documentation-fundamentals
📦

documentation-fundamentals

Content revision r1 Safe ⚙️ External commands

提升開發者文件品質

薄弱的文件會拖慢入門導入，並使程式碼更難維護。此技能以實用標準引導 README、JSDoc 和行內註解審查。

Supports: Claude Codex Code(CC)
Maintain this Skill? Claim it 🥉 78 Bronze

Install with my Agent

Copy this request to your Agent. It includes the canonical Skill page and manifest.

Agent request
Review the Skillstore skill "documentation-fundamentals" from https://skillstore.io/skills/danielpodolsky-documentation-fundamentals.md and its manifest at https://skillstore.io/api/skills/danielpodolsky-documentation-fundamentals/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Your Agent should still show its plan and request any confirmation required by the security policy.

Agent-readable resources

Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.

Markdown detail GET /skills/danielpodolsky-documentation-fundamentals.md Signed manifest GET /api/skills/danielpodolsky-documentation-fundamentals/manifest Signed lockfile GET /api/skills/danielpodolsky-documentation-fundamentals/lockfile

Test it

Using "documentation-fundamentals". README 只包含專案名稱和一句預設腳手架句子。

Expected outcome:

  • 新增一句話的目的說明。
  • 說明此專案解決的問題。
  • 新增新開發者可以依循的安裝與快速開始步驟。

Using "documentation-fundamentals". 行內註解重述賦值、迴圈和顯而易見的屬性讀取。

Expected outcome:

  • 移除重複可見行為的註解。
  • 只在註解能說明意圖、限制或不尋常決策時保留。

Using "documentation-fundamentals". 匯出的工具函式有參數名稱，但沒有使用指引。

Expected outcome:

  • 新增參數和回傳值說明。
  • 以文字新增一個範例結果。
  • 記錄呼叫端必須處理的錯誤或限制。

Security Audit

Safe
v8 • 7/6/2026 Open versioned report

All static findings are false positives caused by Markdown fences, inline code formatting, or prose examples in SKILL.md. I found no executable scripts, prompt injection, data exfiltration intent, or system reconnaissance behavior in the reviewed skill.

1
Files scanned
335
Lines analyzed
0
Review items
0
False positives ignored

Risk Factors

⚙️ External commands (39)
SKILL.md:23-32 SKILL.md:32-44 SKILL.md:44-48 SKILL.md:48-54 SKILL.md:54-59 SKILL.md:59-65 SKILL.md:65-69 SKILL.md:69-75 SKILL.md:75-79 SKILL.md:79-85 SKILL.md:85-91 SKILL.md:91-99 SKILL.md:99-118 SKILL.md:118-122 SKILL.md:122-133 SKILL.md:133-137 SKILL.md:137-147 SKILL.md:147-155 SKILL.md:155-168 SKILL.md:168-172 SKILL.md:172-180 SKILL.md:180-184 SKILL.md:184-191 SKILL.md:191-195 SKILL.md:195-201 SKILL.md:201-205 SKILL.md:205-210 SKILL.md:210-229 SKILL.md:229-253 SKILL.md:253-258 SKILL.md:258-260 SKILL.md:260-273 SKILL.md:273-279 SKILL.md:279-293 SKILL.md:293-302 SKILL.md:302-325 SKILL.md:325-328 SKILL.md:328-331 SKILL.md:331-334
No confirmed security findings were detected by the latest completed static and semantic audit. This does not prove the skill has no side effects.
Audited by: codex View Audit History →
Share & cite this report

Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.

Open versioned report
Security Assessment

Copy report link

https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

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

HTML badge

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

Embed card

<iframe src="https://skillstore.io/embed/skills/danielpodolsky-documentation-fundamentals.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>
Academic citations (APA · BibTeX · CFF)

APA citation

DanielPodolsky. (2026). documentation-fundamentals security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8

BibTeX citation

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

Skillstore Score

Why this score Evidence Confidence: High
55
Architecture
85
Maintainability
87
Content
70
Community
83
Spec Compliance

What You Can Build

審查 README 準備程度

在發布前檢查 README 是否說明目的、安裝、快速開始和貢獻流程。

改善 API 註解

修訂 JSDoc，讓匯出的函式能說明參數、回傳值、錯誤、範例和意圖。

指導程式碼審查

使用聚焦問題來教導何時註解能補充脈絡，以及何時程式碼應該能自行說明。

Try These Prompts

基本 README 審查 
依據五項必要元素審查此 README：目的、問題、安裝、快速開始和貢獻指南。列出缺少的章節與具體修正方式。
行內註解清理 
審查這些行內註解。標記只是在重複程式碼的註解。保留說明意圖、限制或業務脈絡的註解。
JSDoc 完整性檢查 
評估此 API 文件的 JSDoc 完整性。檢查參數、回傳值、錯誤、範例、相關 API 和棄用說明。
儲存庫文件計畫 
為此儲存庫建立文件審查計畫。優先處理 README 缺口、匯出的 API 文件、行內註解，以及過時文件風險。

Best Practices

  • 當程式碼已經顯示行為時，記錄決策存在的原因。
  • 讓 README 步驟可直接複製貼上，並由新開發者測試過。
  • 當行為變更時更新註解，或移除不再補充脈絡的註解。

Avoid

  • 新增只是重述變數名稱、迴圈或賦值的註解。
  • 留下已註解掉的程式碼，而不是依賴版本歷史。
  • 發布未說明實際目的或設定方式的腳手架 README 文字。

Frequently Asked Questions

此技能可以撰寫完整的 README 嗎？
可以。當你提供專案目的、安裝步驟、使用範例和貢獻規則時，它可以起草 README。
它會執行文件測試嗎？
不會。它提供審查指引，但不會執行指令或驗證範例。
哪些工具可以使用它？
它相容於 Claude、Codex 和 Claude Code 技能工作流程。
它可以審查任何語言的註解嗎？
可以。這些原則可廣泛套用，但語言特定標籤應遵循專案標準。
它會取代技術審查嗎？
不會。它改善清晰度和可維護性，但不會證明 API 行為或安全正確性。
我應該如何提供脈絡？
在要求審查前，請分享 README、註解、目標受眾，以及任何已知的設定規則。

Developer Details

License

MIT

Skillstore revision

r1

Version notice

The author did not declare a version.

Repository

https://github.com/DanielPodolsky/mentor-spec/tree/main/.claude/skills/fundamentals/documentation

Ref

34f316ba14ef36c7a620fc09f2676d2429997a77

Maintenance freshness

7/18/2026

Usage

5 downloads · 220 views

File structure

📄 SKILL.md