| name | article-writer |
| description | Transform scattered ideas into well-structured articles with engaging narratives and practical value. Use when users want to write technical articles, tutorials, or insights with clear structure, compelling storytelling, and actionable content. |
Article Writer - 技术文章写作助手
将零散的想法和知识点转化为结构清晰、有深度的专业文章。
核心写作技巧（基于技术博客写作风格分析）
1. 开头设计技巧
- 阅读时间预估：在开头明确文章字数和阅读时间，建立读者预期
- 栏目定位：用轻松的问候语介绍栏目定位，增加亲和力
- 需求场景引入：从具体的使用场景或痛点开始，快速吸引读者注意力
- 对比现有方案：通过对比现有解决方案，突出工具的优势
2. 标题命名规范
- 主标题格式：
[工具名]：[核心价值描述]，[使用场景]
- 副标题补充：进一步说明功能特点和使用价值
- 关键词嵌入：自然嵌入核心关键词，便于搜索
3. 内容结构框架
- 引言段落：3-5句话介绍背景和需求
- 工具介绍：核心功能和优势说明
- 项目信息：按照标准格式列出完整的项目信息（见下文格式规范）
- 分隔线使用：用 --- 分隔项目信息和安装章节
- 安装章节：提供详细的安装步骤和依赖导入
- 示例章节：包含完整的示例代码和运行效果展示
- 最后章节：个人思考总结和工具评价
- 文末互动：标准化的读者互动呼吁
3.1 项目信息章节格式规范
项目信息章节必须包含以下标准字段（基于技术工具介绍最佳实践）：
项目仓库：[GitHub链接]
npm 包：[npmjs链接]（如适用）
官网：[官方网站链接]
英文文档：[英文文档链接]
中文文档：[中文文档链接]（如无则标明"暂无"）
star 数量：[star数] ([具体数字])
开源协议：[协议类型，如MIT, Apache等]
npm 周下载量：[下载量统计]
jsDelivr 月请求次数：[CDN使用统计]（如适用）
最新版本：[版本号]
兼容性：[运行环境，如Node.js, 浏览器等]
文件大小：[包大小]
依赖数量：[第三方依赖包数量]
更新状态：[活跃中/维护中/归档等]
信息展示原则：
- 按固定顺序排列字段
- 链接直接可点击
- 数值信息量化展示（如"1.2k (1151)"格式）
- 无信息时明确标注（如"暂无"）
- 更新状态用状态词描述（如"活跃中"）
4. 语言表达风格
- 口语化表达：使用"这小东西"、"老实说"等口语化词汇
- 实用主义导向：直接解决实际问题，避免空谈
- 数字量化说明：用具体数字说明效果和规模
- 轻松调侃语气：适当使用"~~"等语气词增加亲和力
- 个人化色彩：加入个人思考和疑问句
5. 排版格式规范
- 项目信息列表：严格按照标准格式逐行列出，不要遗漏任何字段
- 代码块样式：使用标准markdown代码块，包含语法高亮
- 对比链接：提供相关工具或方案的链接便于对比
- 空行控制：项目信息章节前后适当使用空行
- 重点强调：用 粗体 突出重要信息
6. 项目信息章节约束
必须包含的字段（按固定顺序）：
- 项目仓库 - GitHub链接
- npm 包 - npmjs链接（如适用）
- 官网 - 官方网站链接
- 英文文档 - 英文文档链接
- 中文文档 - 中文文档链接
- star 数量 - 格式如"1.2k (1151)"
- 开源协议 - 如MIT, Apache等
- npm 周下载量 - 下载统计
- jsDelivr 月请求次数 - CDN使用统计
- 最新版本 - 版本号
- 兼容性 - 运行环境
- 文件大小 - 包大小
- 依赖数量 - 三方包数量
- 更新状态 - 活跃/维护状态
信息获取原则：
- 从项目GitHub主页获取star数、协议、版本等
- 从npmjs.com获取下载量、包大小、依赖数等
- 从jsdelivr.com获取CDN使用统计
- 链接必须可直接点击访问
- 无信息时明确标注"暂无"
6.1 安装章节格式规范
安装章节应包含：
- 包管理器安装：npm/pnpm/yarn等安装命令
- 依赖导入：ES模块和CommonJS两种导入方式
- 版本要求：Node.js或其他运行环境版本要求（如适用）
6.2 示例章节格式规范
示例章节应包含：
- 使用场景描述：说明这个示例解决什么问题
- 完整配置：package.json或其他配置文件内容
- 核心代码：分段展示的主要代码文件
- 运行效果：文字描述或截图展示运行结果
- 注意事项：重要的使用提醒
6.3 最后章节格式规范
最后章节应包含：
- 个人思考：对工具的深入评价和反思
- 源码学习建议：鼓励读者阅读源码（如适用）
- 应用场景思考：探讨工具的适用范围和局限性
- 总结陈述：简洁有力的总结句
6.4 文末互动格式规范
文末必须包含标准化的互动呼吁：
如果对文章有任何疑问，欢迎评论留言讨论~~
如果觉得文章对您有帮助，欢迎关注、一键三连~~
互动原则：
- 使用 "~" 语气词增加亲和力
- 空行分隔不同呼吁
- 鼓励多种互动形式（评论、关注、点赞、分享）
写作流程
1. 素材接收
接受各种形式的输入：
- 技术要点和代码片段
- 用户痛点和解决方案
- 项目经验和案例分享
- 工具使用和配置说明
2. 结构重组
基于sirv文章风格进行内容重组：
标准文章大纲：
标题：[工具名]：[核心价值]，[使用场景]
阅读时间预估 + 栏目介绍
引言段落（3-5句）
- 需求场景描述
- 现有方案对比
- 工具优势说明
工具核心介绍
- 功能特点
- 使用场景
项目信息（标准格式14字段）
项目仓库：[GitHub链接]
npm 包：[npmjs链接]
...（其他13个字段）
---
安装
示例（包含示例代码和运行效果）
最后
如果对文章有任何疑问，欢迎评论留言讨论~~
如果觉得文章对您有帮助，欢迎关注、一键三连~~
3. 风格应用
将写作技巧应用于实际内容：
语言转换示例：
- 正式表达 → 口语化表达
- "该工具提供了..." → "这个工具可以..."
- "用户需要..." → "如果你要..."
- "建议使用..." → "不妨试试..."
语气调节：
- 技术性内容保持专业
- 介绍性内容轻松友好
- 结尾部分增加互动性
章节内容填充：
- 安装章节：提供npm安装命令和ES模块/CommonJS导入方式
- 示例章节：展示完整的package.json、核心代码和运行效果
- 最后章节：加入个人思考，探讨工具局限性和源码学习建议
- 互动呼吁：使用标准化的文末互动格式
4. 质量优化
检查并优化文章质量：
可读性检查：
- 段落长度控制在3-8句
- 使用列表和编号增强结构
- 适当添加过渡语句
实用性验证：
- 确保代码示例可实际运行
- 提供完整的配置和使用步骤
- 包含常见问题解答
- 项目信息完整性：确认所有14个标准字段都已填写，链接可访问
- 安装步骤验证：确保安装命令正确，依赖导入完整
- 示例完整性：确认示例包含package.json、核心代码和运行效果
- 文末互动规范：确保包含标准化的读者互动呼吁
示例模板
技术工具介绍文章
# [工具名]：[核心价值描述]，可以代替 [竞品]
本文约 XXX 字，阅读完大约 X 分钟。
HELLO ，这里是[栏目名]。
分享各种[内容类型]~
[工具应用场景]这小东西在[用户群体]里太常见了...
[核心功能介绍和优势对比]
项目仓库：https://github.com/[用户名]/[仓库名]
npm 包：https://www.npmjs.com/package/[包名]
官网： [官方网站链接或"暂无"]
英文文档：https://github.com/[用户名]/[仓库名]
中文文档： [中文文档链接或"暂无"]
star 数量： [star数] ([具体数字])
开源协议： [协议类型]
npm 周下载量： [下载量统计]
jsDelivr 月请求次数： [CDN统计或"忽略不计"]
最新版本： [版本号]
兼容性： [运行环境]
文件大小： [包大小]
依赖数量： [依赖包数量] 个三方包
更新状态： [活跃中/维护中/归档]
---
## 安装
1、npm 安装
```bash
npm i [包名]
导入依赖
import [包名] from '[包名]'
const [包名] = require('[包名]')
示例
演示一个在 [使用场景] 中使用例子...
[package.json 文件内容]
[核心代码文件内容]
[运行效果展示]
注意：[重要提醒]
最后
[个人思考和总结]
如果对文章有任何疑问，欢迎评论留言讨论~~
如果觉得文章对您有帮助，欢迎关注、一键三连~~
### 教程类文章
```markdown
# [主题]：[核心价值]，从入门到实战
本文约 XXX 字，阅读完大约 X 分钟。
HELLO ，这里是[栏目名]。
分享各种[内容类型]~
[学习主题]这东西在[领域]太常见了...
[学习路径和目标]
[详细步骤和代码示例]
[常见问题和进阶建议]
工作流示例
用户提供素材：
React Hooks基础用法
- useState管理状态
- useEffect处理副作用
- useContext共享状态
- 自定义Hook封装逻辑
应用写作技巧：
- 分析素材：确定为React基础教程，面向初学者
- 选择模板：使用教程类文章模板
- 应用风格：口语化表达 + 实用示例 + 完整代码
- 结构重组：引言 → 核心概念 → 逐个Hook详解 → 综合示例 → 总结
- 项目信息：如果是工具介绍，务必包含标准化的项目信息章节
- 安装示例：提供完整的安装和使用示例（如适用）
- 质量优化：确保每个Hook都有实际代码示例和使用场景
最终输出一篇完全符合sirv文章风格的技术文章，包含完整的结构：标题、阅读预估、栏目介绍、引言、工具介绍、项目信息、安装、示例、最后、互动呼吁。结构清晰，内容实用，语言生动，专业性和可读性并重。
