# Technical Article Writer

> 【技术文章】编写专业技术文章，生成结构化 Markdown 内容。触发时机：用户说"写技术文章"、"技术博客"、"开发者文档"、"技术教程"时。

- Skill: `afine907/technical-article-writer` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add afine907/technical-article-writer`
- Raw SKILL.md: https://api.skillmd.com/api/skills/afine907/technical-article-writer/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: afine907 (https://skillmd.com/u/afine907)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/afine907/technical-article-writer

---


# 技术文章编写

## Goal

编写专业的、可直接发布的技术文章，通过检索相关资料生成结构化的 Markdown 格式内容，包含教程式实践步骤、代码示例和参考资料来源。

## Trigger

- 用户说"写一篇技术文章"、"写技术博客"、"写教程"
- 用户需要生成包含代码示例和参考资料的结构化技术文档
- 用户要求编写技术博客、开发者文档或技术教程

## 概述

本技能帮助 Claude 编写专业、可直接发布的技术文章。通过 MCP web-search 检索相关资料，生成包含以下要素的结构化文章：
- 清晰的标题和目录结构
- 教程式实践步骤
- 语法高亮且带行号的代码示例
- 完整的参考资料来源

## 工作流程

### Step 1: 理解文章主题

接收用户输入的信息：
- **文章大标题**：文章的核心主题
- **内容方向**：文章要涵盖的知识点、角度或目标

### Step 2: 检索相关资料

使用 MCP web-search (`mcp__web-search__bailian_web_search`) 搜索相关技术资料：

```
搜索关键词策略：
1. 主标题关键词 + 技术栈/框架名称
2. 主标题关键词 + "教程"、"指南"、"实践"
3. 主标题关键词 + "最佳实践"、"解决方案"
4. 相关技术概念 + 具体问题
```

检索要点：
- 至少搜索 3-5 个不同角度的关键词
- 优先选择权威技术博客、官方文档、知名开发者
- 收集代码示例、最佳实践、常见问题解决方案

### Step 3: 组织文章结构

根据检索到的资料，组织教程式文章结构：

```markdown
# 文章标题

## 摘要/导言
- 简要介绍主题
- 说明文章目标读者
- 概述将涵盖的内容

## 目录

## 1. 基础知识/前置要求
- 必要的概念解释
- 环境准备
- 依赖安装

## 2. 核心原理/机制
- 技术实现原理
- 架构设计思路
- 关键流程说明

## 3. 实践步骤（教程式）
- 逐步操作指南
- 每个步骤的详细说明
- 注意事项和常见陷阱

## 4. 代码示例
- 完整的可运行代码
- 关键代码段解释
- 代码结构说明

## 5. 最佳实践
- 经验总结
- 性能优化建议
- 安全性考虑

## 6. 常见问题（FAQ）
- 典型问题及解决方案
- 错误排查指南

## 7. 总结
- 核心要点回顾
- 进阶学习方向
- 参考资料
```

### Step 4: 编写文章内容

编写规则：
- **代码示例**：使用 ``` 语法高亮标记，语言标识 + 行号
- **标题层级**：不超过 H3（####），保持结构清晰
- **列表**：使用一致的格式（- 或 1.）
- **强调**：适度使用 **粗体** 和 *斜体*
- **引用**：使用 > 引用重要信息

代码示例格式：
\`\`\`javascript [行号]
// 代码内容
\`\`\`

### Step 5: 添加参考资料

在文章末尾添加参考资料部分：

```markdown
## 参考资料

- [标题](URL) - 来源描述
- [官方文档](URL) - 官方说明
- [技术博客](URL) - 博主名称
```

## 检索策略

### 关键词优化

| 文章类型 | 搜索策略 |
|---------|---------|
| 入门教程 | "主题 + 入门 + 教程" |
| 进阶实践 | "主题 + 实践 + 示例" |
| 原理分析 | "主题 + 原理 + 源码" |
| 最佳实践 | "主题 + 最佳实践 + 总结" |
| 问题解决 | "主题 + 问题 + 解决方案" |

### 信息筛选

优先选择：
- 官方文档和规范
- 知名技术博客（掘金、CSDN、知乎、Medium、Dev.to）
- GitHub README 和 Wiki
- 开源项目官方示例
- 权威技术书籍/文章

## 资源

### references/

包含文章模板和写作指南：
- `article-templates.md` - 常用文章结构模板
- `writing-guidelines.md` - 技术写作规范

### scripts/

包含辅助脚本：
- `validate_article.py` - 验证文章格式和链接