Demo Document Generator
A skill for generating clean, professional documents with consistent structure.
When to apply this skill
Use this skill for:
- - Technical specifications and feature docs
- Project reports and status updates
- API or module documentation
- Meeting minutes and decision logs
- README files and onboarding guides
Document Generation Workflow
- 1. Understand the document type — identify what kind of document is needed and who will read it
- Gather key information — ask only the essential questions (purpose, audience, main content points); don't over-ask
- Choose the right template — pick from the templates below based on type
- Write the draft — fill in the template with real content, not placeholder text
- Review for clarity — ensure each section adds value; cut anything redundant
Templates
Technical Specification
CODEBLOCK0
Project Status Report
CODEBLOCK1
Meeting Minutes
CODEBLOCK2
README / Onboarding Guide
CODEBLOCK3 bash
Installation and first run
CODEBLOCK4
Writing Principles
- - Lead with the "why" — readers should immediately understand the purpose
- Use concrete examples — show real values, real code, real names; avoid
foo/bar placeholders - Keep sections lean — one section = one idea; if a section feels thin, fold it into another
- Tables over lists for structured comparisons; bullet lists for independent items
- Active voice — "The API returns X" not "X is returned by the API"
Output Format
Always produce the document as a markdown code block so it's easy to copy. If the user seems to want a file saved to disk, write it as a .md file in the current directory and tell them where it is.
演示文档生成器
一种用于生成结构一致、专业清晰文档的技能。
何时应用此技能
适用于以下场景:
- - 技术规格与功能文档
- 项目报告与状态更新
- API或模块文档
- 会议纪要与决策记录
- README文件与入门指南
文档生成流程
- 1. 理解文档类型 — 明确所需文档类型及目标读者
- 收集关键信息 — 仅提出必要问题(目的、受众、主要内容要点);避免过度提问
- 选择合适模板 — 根据类型从下方模板中选取
- 撰写草稿 — 用真实内容填充模板,而非占位文本
- 清晰性审查 — 确保每个部分都有价值;删减冗余内容
模板
技术规格
[功能/组件名称]
概述
用一段描述说明这是什么及其存在原因。
目标
非目标
设计/方案
描述解决方案、关键决策及其依据。
API/接口(如适用)
展示接口、端点或数据模型。
待解决问题
参考文档
项目状态报告
[项目名称] — 状态更新([日期])
摘要
用一句话说明整体状况:🟢 正常推进 / 🟡 存在风险 / 🔴 受阻
本期进展
下一步计划
风险与阻碍
| 问题 | 影响 | 负责人 | 状态 |
|------|------|--------|------|
指标(如适用)
| 指标 | 目标值 | 实际值 |
|------|--------|--------|
会议纪要
会议:[主题] — [日期]
参会人员: [姓名]
主持人: [姓名]
议程
- 1. [议题1]
- [议题2]
讨论与决策
[议题1]
行动项
下次会议
[日期、时间、议程预览]
README / 入门指南
[项目名称]
[一句话标语]
这是什么?
简要描述——解决什么问题?
快速开始
bash
安装与首次运行
使用方法
包含实际命令或代码的核心用法示例。
配置
关键选项及其设置方法。
贡献指南
如何开始参与贡献。
许可证
[许可证类型]
写作原则
- - 以为什么开头 — 读者应能立即理解文档目的
- 使用具体示例 — 展示真实数值、真实代码、真实名称;避免使用foo/bar占位符
- 保持章节精简 — 一个章节只表达一个观点;若章节内容单薄,可合并至其他章节
- 结构化对比用表格,独立项目用列表
- 主动语态 — 使用API返回X而非X由API返回
输出格式
始终以Markdown代码块形式输出文档,便于复制。若用户希望保存为文件,则在当前目录写入.md文件并告知文件位置。