technical-writing-skill

Name: technical-writing-skill
Author: MagicCube

489stars57forks

How to install technical-writing-skill?

magiccube/agentara/technical-writing-skill

$npx -y skills add MagicCube/agentara --skill technical-writing-skill

Installs into the current project.

Summary

A skill for technical writing. This skill should be used when users want to write a technical article.

Files · 1

View on GitHub

SKILL.md

1	## Overview
2
3	这是一个模块化、渐进式加载的技术写作 skill。
4
5	整个写作流程分为 4 个阶段，每个阶段有独立的文档指南：
6
7	```mermaid
8	graph TD
9	A[阶段 0: 主题确认] --> B[阶段 1: 深度调研]
10	B --> C[阶段 2: 大纲设计]
11	C --> D[阶段 3: 内容创作]
12	D --> E[阶段 4: 迭代优化]
13	```
14
15	---
16
17	## Workflow
18
19	### 阶段 0: 主题确认 📋
20
21	目标: 明确写作主题、目标读者、核心价值
22
23	详细指南: 👉 当进入此阶段时，读取 `stage-0-topic.md`
24
25	产出文件: `wikis/writing/drafts/{article-slug}/00-topic.md`
26
27	下一步: 用户确认后 → 进入阶段 1
28
29	---
30
31	### 阶段 1: 深度调研 🔍
32
33	目标: 通过搜索、阅读、分析，形成对主题的深入理解
34
35	详细指南: 👉 当进入此阶段时，读取 `stage-1-research.md`
36
37	产出文件: `wikis/writing/drafts/{article-slug}/01-research.md`
38
39	关键检查: 👉 参考 `checklists/research-checklist.md`
40
41	下一步: 用户确认调研充分 → 进入阶段 2
42
43	---
44
45	### 阶段 2: 大纲设计 📝
46
47	目标: 设计文章结构，明确每个章节的内容和目标
48
49	详细指南: 👉 当进入此阶段时，读取 `stage-2-outline.md`
50
51	产出文件: `wikis/writing/drafts/{article-slug}/02-outline.md`
52
53	关键检查: 👉 参考 `checklists/outline-checklist.md`
54
55	下一步: 用户确认大纲合理 → 进入阶段 3
56
57	---
58
59	### 阶段 3: 内容创作 ✍️
60
61	目标: 根据大纲创作完整文章
62
63	详细指南: 👉 当进入此阶段时，读取 `stage-3-writing.md`
64
65	产出文件: `wikis/writing/drafts/{article-slug}/03-draft-v1.md`
66
67	关键检查: 👉 参考 `checklists/writing-checklist.md`
68
69	下一步: 用户反馈 → 进入阶段 4
70
71	---
72
73	### 阶段 4: 迭代优化 🔄
74
75	目标: 根据反馈持续优化，直到满意
76
77	详细指南: 👉 当进入此阶段时，读取 `stage-4-iteration.md`
78
79	产出文件:
80	- `03-draft-v2.md`, `03-draft-v3.md` ...
81	- `03-draft-final.md`
82
83	下一步: 用户满意 → 发布到 `wikis/writing/published/`
84
85	---
86
87	## Quick Start
88
89	### 用户发起写作请求
90
91	当用户说："我想写一篇关于 XXX 的文章"
92
93	立即执行:
94
95	1. 读取主题确认指南:
96	```
97	Read: .claude/skills/technical-writing-skill/stage-0-topic.md
98	```
99
100	2. 按指南与用户对话，确认：
101	- 文章主题
102	- 目标读者
103	- 文章类型
104	- 预期长度
105
106	3. 创建工作目录:
107	```bash
108	wikis/writing/drafts/{article-slug}/
109	```
110
111	4. 使用模板生成 `00-topic.md`:
112	```
113	Read: templates/00-topic-template.md
114	填充后 Write 到工作目录
115	```
116
117	5. 征求用户确认，获得确认后 → 进入阶段 1
118
119	---
120
121	## Progressive Loading Strategy
122
123	### 🔑 核心原则
124
125	只在需要时加载对应阶段的文档，避免一次性加载所有内容。
126
127	### 📚 加载时机
128
129	\| 阶段 \| 触发条件 \| 需要加载的文档 \|
130	\| --- \| --- \| --- \|
131	\| 阶段 0 \| 用户发起写作请求 \| `stage-0-topic.md` + `templates/00-topic-template.md` \|
132	\| 阶段 1 \| 用户确认主题 \| `stage-1-research.md` + `templates/01-research-template.md` + `checklists/research-checklist.md` \|
133	\| 阶段 2 \| 用户确认调研充分 \| `stage-2-outline.md` + `templates/02-outline-template.md` + `checklists/outline-checklist.md` + `wikis/writing/technical-writing-guide.md` \|
134	\| 阶段 3 \| 用户确认大纲 \| `stage-3-writing.md` + `checklists/writing-checklist.md` + `wikis/writing/technical-writing-guide.md` \|
135	\| 阶段 4 \| 用户提供反馈 \| `stage-4-iteration.md` + `templates/version-changelog-template.md` \|
136
137	### 💡 上下文优化技巧
138
139	1. 阅后即弃: 读取指南文档后，提取关键步骤，不需要完整保留在上下文中
140	2. 模板复用: 模板文件读取后直接填充使用，不保留原始模板
141	3. 检查清单: 在完成某阶段后读取，用于自查，完成后可以丢弃
142
143	---
144
145	## File Structure
146
147	```
148	.claude/skills/technical-writing-skill/
149	├── SKILL.md # 本文件：主入口，流程概览
150	├── stage-0-topic.md # 阶段 0 详细指南
151	├── stage-1-research.md # 阶段 1 详细指南（含工具使用）
152	├── stage-2-outline.md # 阶段 2 详细指南（含结构模板）
153	├── stage-3-writing.md # 阶段 3 详细指南（含写作规范）
154	├── stage-4-iteration.md # 阶段 4 详细指南（含版本管理）
155	├── templates/
156	│ ├── 00-topic-template.md # 主题确认模板
157	│ ├── 01-research-template.md # 调研报告模板
158	│ ├── 02-outline-template.md # 文章大纲模板
159	│ └── version-changelog-template.md # 版本变更说明模板
160	└── checklists/
161	├── research-checklist.md # 调研质量检查清单
162	├── outline-checklist.md # 大纲设计检查清单
163	└── writing-checklist.md # 写作质量检查清单
164	```
165
166	---
167
168	## Global References
169
170	以下文件在多个阶段都会用到，可根据需要加载：
171
172	- 写作风格指南: `wikis/writing/technical-writing-guide.md`
173	- 阶段 2（大纲设计）需要
174	- 阶段 3（内容创作）需要
175
176	- 已发布文章: `wikis/writing/published/`
177	- 可作为风格参考
178	- 可作为系列文章索引来源
179
180	---
181
182	## State Management
183
184	### 当前状态跟踪
185
186	在执行过程中，维护以下状态信息（轻量级）：
187
188	```markdown
189	当前项目: {article-slug}
190	当前阶段: 0/1/2/3/4
191	工作目录: wikis/writing/drafts/{article-slug}/
192	已完成文件: [列表]
193	待确认事项: [列表]
194	```
195
196	### 阶段切换
197
198	每次切换阶段时：
199
200	1. ✅ 总结当前阶段成果
201	2. 📋 征求用户确认
202	3. 🗑️ 清理不再需要的上下文
203	4. 📚 加载下一阶段的指南文档
204
205	---
206
207	## Example Flow
208
209	### 完整流程示例
210
211	用户: "我想写一篇关于 LangGraph 1.0 的实战教程"
212
213	AI:
214	```markdown
215	好的，昕哥！我来帮你创作这篇文章。
216
217	[读取 stage-0-topic.md]
218
219	让我先确认几个问题：
220	1. 目标读者是？（初学者/进阶）
221	2. 重点介绍哪些新特性？
222	3. 想做什么样的 Demo？
223	...
224
225	[创建工作目录 wikis/writing/drafts/langgraph-1.0-tutorial/]
226	[读取并填充 templates/00-topic-template.md]
227	[写入 00-topic.md]
228
229	请查看 00-topic.md，确认无误后我开始深度调研。
230	```
231
232	用户: "确认"
233
234	AI:
235	```markdown
236	收到！进入阶段 1：深度调研
237
238	[读取 stage-1-research.md]
239	[读取 checklists/research-checklist.md]
240
241	我将搜索：
242	✅ LangGraph 1.0 官方文档
243	✅ GitHub changelog 和 examples
244	✅ 社区博客
245	...
246
247	[执行调研...]
248	[读取 templates/01-research-template.md]
249	[填充并写入 01-research.md]
250
251	调研完成！共发现 8 个关键点。
252	请查看 01-research.md 的 Key Findings 部分。
253
254	调研是否充分？
255	```
256
257	用户: "充分，继续"
258
259	AI:
260	```markdown
261	收到！进入阶段 2：大纲设计
262
263	[读取 stage-2-outline.md]
264	[读取 wikis/writing/technical-writing-guide.md]
265	[读取 checklists/outline-checklist.md]
266
267	[设计大纲...]
268	[读取 templates/02-outline-template.md]
269	[填充并写入 02-outline.md]
270
271	大纲已完成！共 8 个章节，预计 8500 字。
272	请查看 02-outline.md。
273
274	结构是否合

People who liked this also viewed

6 picks

Type

grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026537k182k
lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026379k16k
lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026295k16k
docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026157k163k
edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026154k181k
lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026154k16k

technical-writing-skill

489stars57forks

View on GitHub

How to install technical-writing-skill?

magiccube/agentara/technical-writing-skill

$npx -y skills add MagicCube/agentara --skill technical-writing-skill

Installs into the current project.

Summary

A skill for technical writing. This skill should be used when users want to write a technical article.

Files · 1

View on GitHub

SKILL.md

1	## Overview
2
3	这是一个模块化、渐进式加载的技术写作 skill。
4
5	整个写作流程分为 4 个阶段，每个阶段有独立的文档指南：
6
7	```mermaid
8	graph TD
9	A[阶段 0: 主题确认] --> B[阶段 1: 深度调研]
10	B --> C[阶段 2: 大纲设计]
11	C --> D[阶段 3: 内容创作]
12	D --> E[阶段 4: 迭代优化]
13	```
14
15	---
16
17	## Workflow
18
19	### 阶段 0: 主题确认 📋
20
21	目标: 明确写作主题、目标读者、核心价值
22
23	详细指南: 👉 当进入此阶段时，读取 `stage-0-topic.md`
24
25	产出文件: `wikis/writing/drafts/{article-slug}/00-topic.md`
26
27	下一步: 用户确认后 → 进入阶段 1
28
29	---
30
31	### 阶段 1: 深度调研 🔍
32
33	目标: 通过搜索、阅读、分析，形成对主题的深入理解
34
35	详细指南: 👉 当进入此阶段时，读取 `stage-1-research.md`
36
37	产出文件: `wikis/writing/drafts/{article-slug}/01-research.md`
38
39	关键检查: 👉 参考 `checklists/research-checklist.md`
40
41	下一步: 用户确认调研充分 → 进入阶段 2
42
43	---
44
45	### 阶段 2: 大纲设计 📝
46
47	目标: 设计文章结构，明确每个章节的内容和目标
48
49	详细指南: 👉 当进入此阶段时，读取 `stage-2-outline.md`
50
51	产出文件: `wikis/writing/drafts/{article-slug}/02-outline.md`
52
53	关键检查: 👉 参考 `checklists/outline-checklist.md`
54
55	下一步: 用户确认大纲合理 → 进入阶段 3
56
57	---
58
59	### 阶段 3: 内容创作 ✍️
60
61	目标: 根据大纲创作完整文章
62
63	详细指南: 👉 当进入此阶段时，读取 `stage-3-writing.md`
64
65	产出文件: `wikis/writing/drafts/{article-slug}/03-draft-v1.md`
66
67	关键检查: 👉 参考 `checklists/writing-checklist.md`
68
69	下一步: 用户反馈 → 进入阶段 4
70
71	---
72
73	### 阶段 4: 迭代优化 🔄
74
75	目标: 根据反馈持续优化，直到满意
76
77	详细指南: 👉 当进入此阶段时，读取 `stage-4-iteration.md`
78
79	产出文件:
80	- `03-draft-v2.md`, `03-draft-v3.md` ...
81	- `03-draft-final.md`
82
83	下一步: 用户满意 → 发布到 `wikis/writing/published/`
84
85	---
86
87	## Quick Start
88
89	### 用户发起写作请求
90
91	当用户说："我想写一篇关于 XXX 的文章"
92
93	立即执行:
94
95	1. 读取主题确认指南:
96	```
97	Read: .claude/skills/technical-writing-skill/stage-0-topic.md
98	```
99
100	2. 按指南与用户对话，确认：
101	- 文章主题
102	- 目标读者
103	- 文章类型
104	- 预期长度
105
106	3. 创建工作目录:
107	```bash
108	wikis/writing/drafts/{article-slug}/
109	```
110
111	4. 使用模板生成 `00-topic.md`:
112	```
113	Read: templates/00-topic-template.md
114	填充后 Write 到工作目录
115	```
116
117	5. 征求用户确认，获得确认后 → 进入阶段 1
118
119	---
120
121	## Progressive Loading Strategy
122
123	### 🔑 核心原则
124
125	只在需要时加载对应阶段的文档，避免一次性加载所有内容。
126
127	### 📚 加载时机
128
129	\| 阶段 \| 触发条件 \| 需要加载的文档 \|
130	\| --- \| --- \| --- \|
131	\| 阶段 0 \| 用户发起写作请求 \| `stage-0-topic.md` + `templates/00-topic-template.md` \|
132	\| 阶段 1 \| 用户确认主题 \| `stage-1-research.md` + `templates/01-research-template.md` + `checklists/research-checklist.md` \|
133	\| 阶段 2 \| 用户确认调研充分 \| `stage-2-outline.md` + `templates/02-outline-template.md` + `checklists/outline-checklist.md` + `wikis/writing/technical-writing-guide.md` \|
134	\| 阶段 3 \| 用户确认大纲 \| `stage-3-writing.md` + `checklists/writing-checklist.md` + `wikis/writing/technical-writing-guide.md` \|
135	\| 阶段 4 \| 用户提供反馈 \| `stage-4-iteration.md` + `templates/version-changelog-template.md` \|
136
137	### 💡 上下文优化技巧
138
139	1. 阅后即弃: 读取指南文档后，提取关键步骤，不需要完整保留在上下文中
140	2. 模板复用: 模板文件读取后直接填充使用，不保留原始模板
141	3. 检查清单: 在完成某阶段后读取，用于自查，完成后可以丢弃
142
143	---
144
145	## File Structure
146
147	```
148	.claude/skills/technical-writing-skill/
149	├── SKILL.md # 本文件：主入口，流程概览
150	├── stage-0-topic.md # 阶段 0 详细指南
151	├── stage-1-research.md # 阶段 1 详细指南（含工具使用）
152	├── stage-2-outline.md # 阶段 2 详细指南（含结构模板）
153	├── stage-3-writing.md # 阶段 3 详细指南（含写作规范）
154	├── stage-4-iteration.md # 阶段 4 详细指南（含版本管理）
155	├── templates/
156	│ ├── 00-topic-template.md # 主题确认模板
157	│ ├── 01-research-template.md # 调研报告模板
158	│ ├── 02-outline-template.md # 文章大纲模板
159	│ └── version-changelog-template.md # 版本变更说明模板
160	└── checklists/
161	├── research-checklist.md # 调研质量检查清单
162	├── outline-checklist.md # 大纲设计检查清单
163	└── writing-checklist.md # 写作质量检查清单
164	```
165
166	---
167
168	## Global References
169
170	以下文件在多个阶段都会用到，可根据需要加载：
171
172	- 写作风格指南: `wikis/writing/technical-writing-guide.md`
173	- 阶段 2（大纲设计）需要
174	- 阶段 3（内容创作）需要
175
176	- 已发布文章: `wikis/writing/published/`
177	- 可作为风格参考
178	- 可作为系列文章索引来源
179
180	---
181
182	## State Management
183
184	### 当前状态跟踪
185
186	在执行过程中，维护以下状态信息（轻量级）：
187
188	```markdown
189	当前项目: {article-slug}
190	当前阶段: 0/1/2/3/4
191	工作目录: wikis/writing/drafts/{article-slug}/
192	已完成文件: [列表]
193	待确认事项: [列表]
194	```
195
196	### 阶段切换
197
198	每次切换阶段时：
199
200	1. ✅ 总结当前阶段成果
201	2. 📋 征求用户确认
202	3. 🗑️ 清理不再需要的上下文
203	4. 📚 加载下一阶段的指南文档
204
205	---
206
207	## Example Flow
208
209	### 完整流程示例
210
211	用户: "我想写一篇关于 LangGraph 1.0 的实战教程"
212
213	AI:
214	```markdown
215	好的，昕哥！我来帮你创作这篇文章。
216
217	[读取 stage-0-topic.md]
218
219	让我先确认几个问题：
220	1. 目标读者是？（初学者/进阶）
221	2. 重点介绍哪些新特性？
222	3. 想做什么样的 Demo？
223	...
224
225	[创建工作目录 wikis/writing/drafts/langgraph-1.0-tutorial/]
226	[读取并填充 templates/00-topic-template.md]
227	[写入 00-topic.md]
228
229	请查看 00-topic.md，确认无误后我开始深度调研。
230	```
231
232	用户: "确认"
233
234	AI:
235	```markdown
236	收到！进入阶段 1：深度调研
237
238	[读取 stage-1-research.md]
239	[读取 checklists/research-checklist.md]
240
241	我将搜索：
242	✅ LangGraph 1.0 官方文档
243	✅ GitHub changelog 和 examples
244	✅ 社区博客
245	...
246
247	[执行调研...]
248	[读取 templates/01-research-template.md]
249	[填充并写入 01-research.md]
250
251	调研完成！共发现 8 个关键点。
252	请查看 01-research.md 的 Key Findings 部分。
253
254	调研是否充分？
255	```
256
257	用户: "充分，继续"
258
259	AI:
260	```markdown
261	收到！进入阶段 2：大纲设计
262
263	[读取 stage-2-outline.md]
264	[读取 wikis/writing/technical-writing-guide.md]
265	[读取 checklists/outline-checklist.md]
266
267	[设计大纲...]
268	[读取 templates/02-outline-template.md]
269	[填充并写入 02-outline.md]
270
271	大纲已完成！共 8 个章节，预计 8500 字。
272	请查看 02-outline.md。
273
274	结构是否合

People who liked this also viewed

6 picks

Type