Skills

Technical Writing Skill

For technical writing.

Install

npx skills add MagicCube/agentara --skill technical-writing-skill -g -a claude-code -y
Repository
MagicCube/agentara516
Category
Writing
Updated
6mo ago
License
See repository
Context cost
Lightabout 1,340 tokens
Runs scripts
No, instructions only

What it does

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

Overview

这是一个模块化、渐进式加载的技术写作 skill。

整个写作流程分为 4 个阶段,每个阶段有独立的文档指南:

graph TD
    A[阶段 0: 主题确认] --> B[阶段 1: 深度调研]
    B --> C[阶段 2: 大纲设计]
    C --> D[阶段 3: 内容创作]
    D --> E[阶段 4: 迭代优化]

Workflow

阶段 0: 主题确认 📋

目标: 明确写作主题、目标读者、核心价值

详细指南: 👉 当进入此阶段时,读取 stage-0-topic.md

产出文件: wikis/writing/drafts/{article-slug}/00-topic.md

下一步: 用户确认后 → 进入阶段 1


阶段 1: 深度调研 🔍

目标: 通过搜索、阅读、分析,形成对主题的深入理解

详细指南: 👉 当进入此阶段时,读取 stage-1-research.md

产出文件: wikis/writing/drafts/{article-slug}/01-research.md

关键检查: 👉 参考 checklists/research-checklist.md

下一步: 用户确认调研充分 → 进入阶段 2


阶段 2: 大纲设计 📝

目标: 设计文章结构,明确每个章节的内容和目标

详细指南: 👉 当进入此阶段时,读取 stage-2-outline.md

产出文件: wikis/writing/drafts/{article-slug}/02-outline.md

关键检查: 👉 参考 checklists/outline-checklist.md

下一步: 用户确认大纲合理 → 进入阶段 3


阶段 3: 内容创作 ✍️

目标: 根据大纲创作完整文章

详细指南: 👉 当进入此阶段时,读取 stage-3-writing.md

产出文件: wikis/writing/drafts/{article-slug}/03-draft-v1.md

关键检查: 👉 参考 checklists/writing-checklist.md

下一步: 用户反馈 → 进入阶段 4


阶段 4: 迭代优化 🔄

目标: 根据反馈持续优化,直到满意

详细指南: 👉 当进入此阶段时,读取 stage-4-iteration.md

产出文件:

  • 03-draft-v2.md, 03-draft-v3.md ...
  • 03-draft-final.md

下一步: 用户满意 → 发布到 wikis/writing/published/


Quick Start

用户发起写作请求

当用户说:"我想写一篇关于 XXX 的文章"

立即执行:

  1. 读取主题确认指南:

    Read: .claude/skills/technical-writing-skill/stage-0-topic.md
    
  2. 按指南与用户对话,确认:

    • 文章主题
    • 目标读者
    • 文章类型
    • 预期长度
  3. 创建工作目录:

    wikis/writing/drafts/{article-slug}/
    
  4. 使用模板生成 00-topic.md:

    Read: templates/00-topic-template.md
    填充后 Write 到工作目录
    
  5. 征求用户确认,获得确认后 → 进入阶段 1


Progressive Loading Strategy

🔑 核心原则

只在需要时加载对应阶段的文档,避免一次性加载所有内容。

📚 加载时机

Read the whole SKILL.md on GitHub

More in Writing