一天一个开源项目 - 文章生成技能
本技能用于生成"一天一个开源项目"系列的技术文章,帮助读者深入了解优秀的开源项目。
工作流程
Step 1: 收集项目信息
询问用户或从提供的链接获取:
- 项目名称(中英文)和 GitHub/GitLab 地址
- 系列序号(这是第几篇文章)
- 项目类型/分类、编程语言/技术栈
- 项目背景信息(作者、创建时间、统计数据等,可选)
Step 2: 研究项目
- 访问项目 GitHub 页面,阅读 README 和文档
- 查看项目结构和主要功能
- 了解作者/团队信息和项目统计数据
- 查找同类项目进行对比
Step 3: 生成文章
按照模板结构生成文章,确保包含所有必需部分。详细模板和格式要求见 文章模板。
文章结构要求
文章必须包含以下部分:
- YAML Front Matter - 包含 title、date、description、tags、category
- 引言部分 - 介绍项目、学习要点、前置知识
- 项目背景 - 项目简介、作者/团队、项目数据
- 主要功能 - 核心作用、使用场景、快速开始、核心特性、项目优势
- 项目详细剖析 - 深入分析项目的架构、设计、实现等
- 项目地址与资源 - GitHub、文档、社区等链接
- 总结与展望 - 核心要点、适用人群、学习建议
- 结尾 - 个人网站链接和系列文章导航
内容要求
写作风格
- 使用中文,语言自然流畅
- 技术术语保持英文原文,必要时加中文解释
- 代码示例必须可运行(或接近可运行),添加必要注释
- 使用多级标题组织内容,重要信息使用列表或表格
内容深度
- 入门友好:解释必要的背景知识,提供足够的上下文
- 实用性强:提供实际的使用示例和常见场景
- 深入剖析:不仅介绍如何使用,还要解释原理和设计思路
质量检查
生成文章后,检查以下项目:
- YAML front matter 格式正确,包含所有必需字段
- 引言部分明确说明这是第X篇
- 项目背景信息完整
- 主要功能部分包含:作用、场景、快速开始、特性、优势
- 项目详细剖析部分有足够深度
- 包含项目地址(GitHub链接)
- 结尾包含个人网站链接
- 代码示例格式正确,可读性强
- 文章结构清晰,逻辑连贯
参考资源
- 详细模板:见 references/article-template.md - 包含完整的文章结构模板和示例
- 示例文章:参考
apps/wonderlab/content/blog/open-source-projects/目录下的现有文章
注意事项
- 不要修改现有文件:除非用户明确要求,否则只创建新文件
- 保持客观:客观评价项目,既说明优点也指出可能的局限性
- 时效性:注意项目信息的时效性,使用最新的版本和特性
- 准确性:确保技术信息的准确性,不确定的内容要标注