技能 technical-writer
📦
technical-writer
v1.0.0 內容修訂 r1 安全 ⚙️ 外部命令🌐 網路存取📁 檔案系統存取🔑 環境變數
建立清晰的技術文件
團隊經常難以將技術細節轉化為清晰的文件。此技能可為 Claude、Codex 和 Claude Code 結構化 README、API 參考文件、教學與指南。
支援: Claude Codex Code(CC)
使用我的智慧代理安裝
將此請求複製給你的智慧代理，其中包含權威 Skill 頁面和清單。
智能體請求
Review the Skillstore skill "technical-writer" from https://skillstore.io/skills/shubhamsaboo-technical-writer.md and its manifest at https://skillstore.io/api/skills/shubhamsaboo-technical-writer/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.你的智慧代理仍應顯示其計畫，並依安全政策請求必要確認。
Agent 可讀資源
當 AI Agent、爬蟲或腳本需要乾淨脈絡、而不是讀取完整頁面時，請使用這些連結。
測試它
正在使用「technical-writer」。 一個 CLI 工具，可依大小排序檔案並匯出 CSV 結果。
預期結果:
一份 README 計畫，包含產品摘要、功能清單、安裝步驟、快速開始、使用範例、設定注意事項、疑難排解與授權章節。
正在使用「technical-writer」。 一個 REST 端點，可建立專案並回傳驗證錯誤。
預期結果:
一頁 API 參考文件，包含目的、參數、回傳值、範例情境、錯誤表與常見失敗的指引。
正在使用「technical-writer」。 新開發者加入服務團隊時所需的複雜設定流程。
預期結果:
一份教學大綱，包含先決條件、依序設定步驟、驗證檢查、常見問題與深入學習的後續步驟。
安全審計
安全v2 • 2026/7/7 開啟版本化報告
All static findings were adjudicated as false positives after reviewing SKILL.md. The alerts point to markdown fences, inline placeholders, and sample documentation commands, not executable code or instructions to run commands. No prompt injection or data exfiltration intent was found.
1
已掃描檔案
352
分析行數
0
複核項目
0
已忽略的誤報
風險因素
⚙️ 外部命令 (56)
SKILL.md:63-92 SKILL.md:92-95 SKILL.md:95-112 SKILL.md:112-114 SKILL.md:114-120 SKILL.md:120-123 SKILL.md:123-140 SKILL.md:140-152 SKILL.md:152-157 SKILL.md:157-178 SKILL.md:178-183 SKILL.md:183-187 SKILL.md:187-189 SKILL.md:189-192 SKILL.md:192-194 SKILL.md:194-197 SKILL.md:197-201 SKILL.md:201-202 SKILL.md:202-205 SKILL.md:205-212 SKILL.md:212-214 SKILL.md:214-220 SKILL.md:220-224 SKILL.md:224-225 SKILL.md:225-233 SKILL.md:233-247 SKILL.md:247-249 SKILL.md:249-254 SKILL.md:254-256 SKILL.md:256-259 SKILL.md:259-264 SKILL.md:264-268 SKILL.md:268-270 SKILL.md:270-276 SKILL.md:276-277 SKILL.md:277-278 SKILL.md:278-279 SKILL.md:279-280 SKILL.md:280-285 SKILL.md:285-287 SKILL.md:287-290 SKILL.md:290-292 SKILL.md:292-295 SKILL.md:295-297 SKILL.md:297-300 SKILL.md:300-302 SKILL.md:302-306 SKILL.md:306-308 SKILL.md:308-314 SKILL.md:314-320 SKILL.md:320-322 SKILL.md:322-326 SKILL.md:326-332 SKILL.md:332-341 SKILL.md:221 SKILL.md:321
🌐 網路存取 (1)
📁 檔案系統存取 (2)
🔑 環境變數 (1)
最近一次完成的靜態與語意稽核未偵測到已確認的安全發現。這並不能證明該 Skill 沒有副作用。
審計單位: codex 檢視審計紀錄 →
分享與引用此報告
分享版本化評估報告、中性徽章、嵌入卡片與引用。Skillstore 只報告證據，不判斷該 Skill 是否安全。
複製報告連結
https://skillstore.io/skills/shubhamsaboo-technical-writer/audits/2?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/shubhamsaboo-technical-writer?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/shubhamsaboo-technical-writer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/shubhamsaboo-technical-writer/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/shubhamsaboo-technical-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 引用
shubhamsaboo. (2026). technical-writer security audit report (audit version 2) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/shubhamsaboo-technical-writer/audits/2BibTeX 引用
@techreport{shubhamsaboo-shubhamsaboo-technical-writer-2026,
author = {shubhamsaboo},
title = {technical-writer security audit report (audit version 2)},
institution = {Skillstore},
year = {2026},
number = {2},
url = {https://skillstore.io/skills/shubhamsaboo-technical-writer/audits/2},
note = {Author version 1.0.0}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "technical-writer security audit report (audit version 2)"
version: "1.0.0"
type: report
authors:
- name: "shubhamsaboo"
date-released: "2026-07-07"
url: "https://skillstore.io/skills/shubhamsaboo-technical-writer/audits/2"
identifiers:
- type: other
value: "skillstore:shubhamsaboo-technical-writer:audit:2"
description: "Skillstore immutable audit report identifier"
Skillstore 評分
評分依據 證據置信度: 中 55
架構
100
可維護性
87
內容
65
社群
91
規範符合度
你可以打造什麼
撰寫專案 README
將專案筆記轉換為清晰的 README 頁面，包含設定、快速開始、使用方式與疑難排解章節。
記錄 API
建立端點或函式參考文件，說明輸入、輸出、範例、錯誤與邊界情境。
建立使用者指南
為正在學習技術工作流程的使用者建立教學、入門指南與支援內容。
試試這些提示
建立 README
為 [project name] 建立 README。包含受眾、專案目標、主要功能、安裝步驟、快速開始、常見使用方式、疑難排解與授權注意事項。
記錄 API
使用清晰章節記錄此 API，涵蓋目的、參數、回傳值、範例、錯誤與邊界情境。使用我提供的來源詳細資料：[paste details]。
撰寫教學
為 [task] 撰寫初學者教學。從先決條件開始，接著提供編號步驟、預期結果、常見錯誤與後續步驟。
重構現有文件
審閱並重構以下文件，以提升清晰度、完整性與可掃讀性。保留技術含義、移除重複內容、找出缺口，並建議缺少的章節：[paste docs]。
最佳實務
- 在請求撰寫文件前，先提供受眾、產品目標與來源詳細資料。
- 建立指南時，請要求包含範例、預期結果與常見錯誤。
- 發布前先審閱產生的命令、URL 與設定路徑。
避免
- 在沒有產品脈絡或來源資料的情況下請求完整文件。
- 未在目標環境中驗證就發布產生的命令範例。
- 將初學者設定步驟與進階參考細節混在同一個未結構化頁面中。
常見問題
此技能可以建立 API 文件嗎？
可以。它可以結構化端點與函式參考文件，包含參數、回傳、範例、錯誤與邊界情境。
它會測試程式碼範例嗎？
不會。它會撰寫文件與範例，但不會執行命令或驗證程式碼行為。
哪些工具可以使用此技能？
報告列出支援 Claude、Codex 和 Claude Code。
它可以改善現有文件嗎？
可以。提供目前文字，並要求更清晰的結構、缺少的章節或特定風格。
它可以為非開發者撰寫嗎？
可以。提供受眾程度，並要求更簡單的用字、較少假設與更多脈絡。
我應該在提示中包含什麼？
包含受眾、目標、來源詳細資料、必要章節、範例，以及任何風格或術語規則。
開發者詳細資訊
作者
shubhamsaboo授權
MIT
作者版本
v1.0.0
Skillstore 修訂
r1
儲存庫
https://github.com/shubhamsaboo/awesome-llm-apps/tree/main/awesome_agent_skills/technical-writer引用
412e23e39ccd9729546286287b96bb41707397cf
維護新鮮度
2026/7/18
使用量
2 次下載 · 0 次瀏覽
檔案結構
📄 SKILL.md