技能 documentation-writer
📦
documentation-writer
內容修訂 r2 安全 🌐 網路存取
建立 Diataxis 軟體文件
團隊經常需要符合使用者意圖的文件，涵蓋教學、操作指南、參考頁面和解釋。此技能會引導 Claude、Codex 和 Claude Code 釐清範圍、提出大綱，並起草結構化 Markdown。
支援: Claude Codex Code(CC)
使用我的智慧代理安裝
將此請求複製給你的智慧代理，其中包含權威 Skill 頁面和清單。
智能體請求
Review the Skillstore skill "documentation-writer" from https://skillstore.io/skills/github-documentation-writer.md and its manifest at https://skillstore.io/api/skills/github-documentation-writer/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.你的智慧代理仍應顯示其計畫，並依安全政策請求必要確認。
Agent 可讀資源
當 AI Agent、爬蟲或腳本需要乾淨脈絡、而不是讀取完整頁面時，請使用這些連結。
測試它
正在使用「documentation-writer」。 撰寫新開發者功能入門文件的請求。
預期結果:
關於受眾和目標的釐清問題，接著提供以首次成功成果為重點的教學大綱。
正在使用「documentation-writer」。 部署任務的已批准大綱。
預期結果:
一份 Markdown 操作指南，包含先決條件、依序排列的步驟、預期結果和簡潔的疑難排解備註。
正在使用「documentation-writer」。 定義產品語氣和術語的現有 Markdown 檔案。
預期結果:
一份修訂後的文件草稿，遵循相同的語氣、命名和結構，但不複製來源文字。
安全審計
安全v5 • 2026/7/23 開啟版本化報告
The skill contains prompt guidance for technical writing and no executable network operation. The Diátaxis website URL is a framework citation, not a request target or data transfer mechanism.
1
已掃描檔案
46
分析行數
0
複核項目
0
已忽略的誤報
風險因素
🌐 網路存取 (1)
最近一次完成的靜態與語意稽核未偵測到已確認的安全發現。這並不能證明該 Skill 沒有副作用。
審計單位: codex 檢視審計紀錄 →
分享與引用此報告
分享版本化評估報告、中性徽章、嵌入卡片與引用。Skillstore 只報告證據，不判斷該 Skill 是否安全。
複製報告連結
https://skillstore.io/skills/github-documentation-writer/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/github-documentation-writer/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/github-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 引用
github. (2026). documentation-writer security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/github-documentation-writer/audits/5BibTeX 引用
@techreport{github-github-documentation-writer-2026,
author = {github},
title = {documentation-writer security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/github-documentation-writer/audits/5},
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 5)"
version: "unspecified"
type: report
authors:
- name: "github"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/github-documentation-writer/audits/5"
identifiers:
- type: other
value: "skillstore:github-documentation-writer:audit:5"
description: "Skillstore immutable audit report identifier"
比較變體
2 個可安裝變體每位作者的技能都保留為獨立的可安裝項目。推薦變體依 Skillstore 證據排序。
為何此變體排名第一
Skillstore 評分最高
作者 / 來源 Skillstore 評分 證據置信度 Skillstore 使用量 已更新
c0ntr0lledcha0s-documentation-writer
Skillstore 評分 38
證據置信度 中
Skillstore 使用量 50
已更新
2026-09-09
Skillstore 評分
評分依據 證據置信度: 高 55
架構
85
可維護性
87
內容
69
社群
83
規範符合度
你可以打造什麼
規劃產品教學
為需要引導式首次成功體驗的使用者，建立以學習為重點的大綱和草稿。
撰寫操作型操作指南
將特定任務轉化為一系列清楚的步驟，並包含範圍和先決條件。
起草參考頁面
將技術事實組織成簡潔的參考資料，方便重複查閱和維護。
試試這些提示
分類我的文件請求
I need documentation for [product or feature]. Help me choose whether it should be a tutorial, how-to guide, reference page, or explanation. Ask any clarifying questions first.
建立 Diataxis 大綱
Create a Diataxis-based outline for a [document type] about [topic]. The target audience is [audience], the goal is [goal], and the scope is [scope].
起草已批准的文件
Use the approved outline to write the full Markdown document. Keep the language simple, accurate, and consistent with the provided product details.
對齊一組文件
Review these documentation drafts for Diataxis alignment. Identify mixed purposes, missing audience context, scope problems, and terminology inconsistencies before proposing revisions.
最佳實務
- 一開始就提供目標受眾、使用者目標、範圍和文件類型。
- 在請求最終草稿前，先審閱並批准提出的大綱。
- 當語氣、術語或結構必須一致時，分享現有文件。
避免
- 在缺少產品詳細資訊或清楚使用者目標的情況下請求完整文件。
- 在同一頁面混合教學、參考和解釋目標。
- 在未提供可信連結或指示的情況下要求外部研究。
常見問題
此技能使用什麼文件框架？
它使用 Diataxis 框架，該框架將教學、操作指南、參考頁面和解釋分開。
它會立即撰寫最終文件嗎？
不會。它會先詢問釐清問題並提出大綱，然後才撰寫完整的 Markdown 草稿。
它可以符合我們現有的文件風格嗎？
可以。提供 Markdown 範例後，它可以用來掌握語氣、術語和結構。
它可以使用外部網站作為來源嗎？
只有在你提供連結並明確指示它使用該來源時才可以。
哪些 AI 工具可以使用此技能？
報告列出支援 Claude、Codex 和 Claude Code。
安裝此技能安全嗎？
這是一個僅含提示的技能，沒有指令碼。稽核未發現已確認的安全問題。