Hongxi tech blog writer
基于 javahongxi 博文风格的技术博客写作助手。擅长开源项目推广、技术深度解读、项目全景介绍、升级公告等类型的技术博文,输出结构清晰、代码丰富、风格统一的高质量 Markdown 文章。From its SKILL.md
npx -y skills add whatsmars/skills --skill hongxi-tech-blog-writerAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
4.8 KB, ~1.9k tokens by cl100k_base, as published. Nobody here has run it
Tech Blog Writer
基于 javahongxi 5 篇技术博文的写作风格,提炼出一套可复用的技术博客写作规范。
触发方式
- "帮我写一篇推广博文"
- "写一篇技术博客介绍这个项目"
- "帮我写个升级公告博文"
- "写一篇项目深度解读"
- "write a tech blog post"
写作流程
Step 1: 明确博文类型
与用户确认博文类型(4 种模板):
| 类型 | 适用场景 | 代表作品 |
|---|---|---|
| 项目推广文 | 向社区推广开源项目 | cloud-promo-blog, whatsmars-promo-blog |
| 技术深度文 | 深入解读某项技术/模块 | spring-ai-blog |
| 项目全景文 | 项目整体概览与亮点 | cloud-blog |
| 升级公告文 | 新版本/新模块发布 | cloud-new-modules-blog |
Step 2: 收集素材
向用户了解:
- 项目名称、GitHub 地址
- 核心技术栈与版本号
- 模块列表与功能说明
- 核心亮点(2-8 个)
- 目标读者(初中级/高级/架构师)
- 快速开始步骤
Step 3: 按模板结构生成
严格遵循下方的文章结构模板。详细风格规范见 style-reference.md。
文章结构模板
# 主标题:副标题(技术栈 + 卖点)
> **技术栈1** | **技术栈2** | **亮点数字** | **覆盖范围**
[1-2 段引入:痛点共鸣 → 项目引出]
---
## 🎯 为什么需要这个项目?
### 痛点一:[标题]
[2-3 行描述 + bullet list]
### 痛点二:[标题]
...
### 痛点三:[标题]
...
---
## 🚀 项目亮点 / 模块深度剖析
### ✨ 1. [亮点标题]——[一句话卖点]
[描述 + 代码示例 + "这意味着:**结论**"]
### 🏗️ 2. [亮点标题]
...
(每个亮点包含:问题 → 方案 → 代码 → 结论)
---
## 🏛️ 架构设计
[ASCII 架构图]
**核心设计理念**:
1. [理念一]
2. [理念二]
---
## 📊 模块速查表
| 模块 | 端口 | 说明 |
|------|------|------|
| ... | ... | ... |
---
## 🎓 学习价值
### 对于初中级开发者
- ✅ [价值点]
### 对于高级开发者
- ✅ [价值点]
### 对于架构师
- ✅ [价值点]
---
## 🚦 快速开始
### 前置要求
- [要求列表]
### [N] 步启动
[代码块:clone → 配置 → 运行 → 验证]
---
## 💡 最佳实践总结
### 1. [实践标题]
[说明 + 代码示例]
### 2. [实践标题]
...
---
## 🔗 相关链接
- 📦 **项目地址**: [URL]
- 📖 **框架文档**: [URL]
(按相关性列出 5-8 个链接)
---
## 📝 结语
[回顾核心价值,2-3 句]
**如果你正在**:
- 🎯 [场景一]
- 🚀 [场景二]
- 🏗️ [场景三]
**Star ⭐ [项目名],[号召语]!**
[git clone 代码块]
---
**© [hongxi.org](http://hongxi.org)**
各类型差异化要点
项目推广文
- 痛点部分着重"为什么需要"
- 亮点覆盖所有核心模块,每个模块 1-2 段
- 学习价值按 3 层受众分层
- 语气:全面、权威、有号召力
技术深度文
- 采用"层级递进"结构(第一层→第二层→...→第九层)
- 每层:概念引入 → 代码演示 → 效果展示 → 关键洞察
- 多用对比表格(temperature 对比、方案对比)
- 语气:深入浅出、有洞察力
项目全景文
- 用"亮点一/二/三..."编号
- 每个亮点:问题背景 → 实现方案 → 代码 → 意义
- 架构图必须详细(ASCII art)
- 模块速查表不可省略
升级公告文
- 开头承接上一篇博文("上一篇博文中...")
- 新增模块用 🆕 标注
- 每个新模块独立成章,包含完整的使用示例
- 末尾"模块总览"表格标注新旧状态
写作规范速查
| 维度 | 规范 |
|---|---|
| 语言 | 中文为主,技术术语保留英文 |
| 段落 | 短段落(2-4 行),多留白 |
| 强调 | 加粗用于核心观点和结论 |
| 代码 | 每个亮点至少 1 个代码示例 |
| 表格 | 模块对比、功能矩阵用表格 |
| 架构图 | ASCII art,不用外部图片 |
| Emoji | 仅用于章节标题,正文不用 |
| 签名 | © [hongxi.org](http://hongxi.org) |
| 篇幅 | 推广文 300-550 行,深度文 350-450 行 |
禁忌
- ❌ 不用"本文将..."开头(用痛点引入)
- ❌ 不在正文中使用 emoji(仅标题)
- ❌ 不写空洞的形容词("非常好""很棒")→ 用数据/代码说话
- ❌ 不省略代码示例(每个亮点必须有代码)
- ❌ 不省略架构图(ASCII art 是标配)
- ❌ 不写没有结论的章节(每个亮点以"这意味着:..."收尾)
What ships with it: 1 file
10.3 KB alongside SKILL.md
- style-reference.md10.3 KB