askill
custom-skills-doc-writer

custom-skills-doc-writerSafety 95Repository

以統一格式撰寫計畫、報告、指南、教學、紀錄、規範等文件。 Use when: 使用者要求撰寫或起草文件,包含但不限於:計畫書(新功能/重構/遷移)、報告(調查/階段/分析)、指南、教學、會議紀錄、事件紀錄、決策紀錄、規範文件。 觸發方式: /custom-skills-doc-writer [type] [variant] Keywords: 撰寫文件, 文件模板, 計畫書, 報告, 指南, 教學, 紀錄, 規範, document writer, plan, report, guide, tutorial, record, standard, 寫文件, 起草, draft

3 stars
1.2k downloads
Updated 2/15/2026

Package Files

Loading files...
SKILL.md

Document Writer — 統一格式文件撰寫

使用方式

/custom-skills-doc-writer [type] [variant]

若使用者已提供完整引數,直接載入對應模板執行。若未提供或資訊不足,透過互動引導。


引數解析

type(文件類型)與 variant(子類型)

typevariant模板說明
planfeaturetemplate-plan-feature.md新功能計畫
planrefactoringtemplate-plan-refactoring.md重構計畫
planmigrationtemplate-plan-migration.md遷移計畫
plangeneraltemplate-plan-general.md通用計畫(預設)
reportinvestigationtemplate-report-investigation.md調查報告
reportstatustemplate-report-status.md階段/進度報告
reportanalysistemplate-report-analysis.md分析報告
guidetemplate-guide.md操作指南
tutorialtemplate-tutorial.md教學文件
recordmeetingtemplate-record-meeting.md會議紀錄
recordincidenttemplate-record-incident.md事件紀錄
recorddecisiontemplate-record-decision.md決策紀錄
standardtemplate-standard.md規範文件

流程

Step 1: 判斷引數來源

依以下優先順序決定 type/variant:

  1. 使用者明確指定 → 直接使用,跳到 Step 3
  2. 未指定但有對話脈絡 → 進入 Step 1.5 脈絡推斷
  3. 無引數且無脈絡 → 進入 Step 2 互動引導

Step 1.5: 脈絡推斷(從對話內容判斷文件類型)

當使用者在對話中說「把剛才的討論寫成文件」「整理成報告」等模糊指令時,根據對話內容特徵推斷文件類型。

推斷規則 — 依對話內容的核心動詞/意圖判斷:

對話特徵推斷結果常見混淆
分析了問題根因、追蹤了呼叫鏈、讀了原始碼report/investigationrecord/incident(incident 是事後紀錄時間線,investigation 是深入分析)
比較了多個方案、評估了優缺點report/analysisrecord/decision(decision 是記錄最終選擇,analysis 是完整比較過程)
討論了線上事故的時間線與處理過程record/incidentreport/investigation(incident 重點是「發生了什麼、怎麼處理」)
做出了技術選型或架構決定record/decisionreport/analysis(decision 重點是「選了什麼、為什麼」)
規劃了要做的功能或改善plan/*再看子類型:有技術債→refactoring、有平台切換→migration、有新需求→feature
討論了某個流程怎麼操作guidetutorial(guide 是參考手冊,tutorial 是分步教學含練習)
教學性質、有步驟練習tutorialguide

關鍵區分原則:

  • report vs record:report 是「分析與結論」(有方法論、有證據鏈、有建議),record 是「事實紀錄」(有時間線、有出席者、有決議)
  • investigation vs incident:investigation 回答「為什麼發生」,incident 回答「發生了什麼、怎麼處理」
  • analysis vs decision:analysis 回答「哪個比較好」,decision 回答「我們選了什麼」

推斷後必須確認: 向使用者明確說明推斷結果並確認:

根據我們剛才的討論(分析了 XX 的根因與影響範圍),建議使用「調查報告」格式。確認嗎?

使用 AskUserQuestion 提供推斷結果作為推薦選項,同時列出其他可能選項讓使用者選擇。

Step 2: 互動引導(無脈絡時)

使用 AskUserQuestion 逐層引導:

第一層 — 文件類型:

  • 計畫 (plan) — 規劃未來要做的事
  • 報告 (report) — 記錄已完成的分析或進展
  • 指南 (guide) — 說明如何完成某件事
  • 教學 (tutorial) — 分步驟教學,含練習
  • 紀錄 (record) — 記錄事件或決策
  • 規範 (standard) — 定義規則與標準

第二層 — 子類型(僅 plan、report、record 需要):

plan:

  • 新功能 (feature)
  • 重構 (refactoring)
  • 遷移 (migration)
  • 通用 (general)

report:

  • 調查報告 (investigation)
  • 階段報告 (status)
  • 分析報告 (analysis)

record:

  • 會議紀錄 (meeting)
  • 事件紀錄 (incident)
  • 決策紀錄 (decision)

Step 3: 載入模板

根據確定的 type/variant,讀取 references/template-{type}-{variant}.md(或 references/template-{type}.md)。

Step 4: 收集文件資訊

詢問使用者必要資訊(若未在指令中提供):

  • 標題: 文件標題
  • 輸出路徑: 文件存放位置(提供合理預設:docs/{type}/ 或當前目錄)

其他 metadata(date、author)自動填入:

  • date: 今天日期
  • author: 從 git config 取得或留空

Step 5: 撰寫文件

根據模板結構撰寫文件內容:

  1. 填入 frontmatter metadata
  2. 根據使用者提供的背景資訊,填充各章節內容
  3. 對於無法推斷的章節,保留模板佔位符並標註 <!-- TODO: 補充 -->
  4. 若使用者提供了參考資料(如 @file),讀取後融入文件內容

Step 6: 後續建議

文件撰寫完成後,根據文件類型提示:

文件類型建議
plan建議使用 /custom-skills-plan-analyze 檢查完整性
report提示是否需要補充資料或請相關人員審閱
standard提示是否需要版本控制與審批流程

共通格式規範

所有文件遵循以下基線:

  • Frontmatter: 所有文件包含 YAML frontmatter(title、type、date、author、status)
  • 標題層級: # 文件標題、## 主要章節、### 子章節,最深不超過 ####
  • 表格: 結構化比較或清單使用 Markdown 表格
  • 清單: 待辦事項使用 - [ ],一般列表使用 -
  • 程式碼: 使用 fenced code block 並標註語言
  • 語言: 預設繁體中文,除非使用者指定其他語言

模板索引

所有模板位於 references/ 目錄:

檔案文件類型
template-plan-feature.md新功能計畫
template-plan-refactoring.md重構計畫
template-plan-migration.md遷移計畫
template-plan-general.md通用計畫
template-report-investigation.md調查報告
template-report-status.md階段報告
template-report-analysis.md分析報告
template-guide.md操作指南
template-tutorial.md教學文件
template-record-meeting.md會議紀錄
template-record-incident.md事件紀錄
template-record-decision.md決策紀錄
template-standard.md規範文件

擴展時只需在 references/ 新增 template-{type}-{variant}.md 並更新上方引數表。

Install

Download ZIP
Requires askill CLI v1.0+

AI Quality Score

89/100Analyzed 2/19/2026

Comprehensive document writer skill with clear usage pattern, detailed 6-step process, and well-structured template system. Includes parameter analysis tables, decision logic for ambiguous cases, and common formatting standards. Extensible design allows adding new templates. No dangerous operations - safe document generation tool.

95
90
85
85
90

Metadata

Licenseunknown
Version-
Updated2/15/2026
PublisherValorVie

Tags

No tags yet.