返回顶部
t

technical-blog-writing技术博客写作

Technical blog post writing with structure, code examples, and developer audience conventions. Covers post types, code formatting, explanation depth, and developer-specific engagement patterns. Use for: engineering blogs, dev tutorials, technical writing, developer content, documentation posts. Triggers: technical blog, dev blog, engineering blog, technical writing, developer tutorial, tech post, code tutorial, programming blog, developer content, technical article, engineering post, coding tuto

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 0.1.5
安全检测
已通过
854
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

technical-blog-writing

技术博客写作

通过 inference.sh CLI 编写面向开发者的技术博客文章。

快速开始

bash
curl -fsSL https://cli.inference.sh | sh && infsh login

研究主题深度

infsh app run exa/search --input { query: building REST API Node.js best practices 2024 tutorial }

生成题图

infsh app run infsh/html-to-image --input { html:

// 工程博客

我们如何通过边缘缓存将API延迟降低90%

深入解析我们的CDN架构

}

安装说明: 安装脚本仅检测您的操作系统/架构,从 dist.inference.sh 下载匹配的二进制文件,并验证其 SHA-256 校验和。无需提升权限或后台进程。提供手动安装与验证

文章类型

1. 教程 / 操作指南

分步指导。读者应能跟随并构建出成果。

结构:

  1. 1. 我们要构建什么(附截图/演示)
  2. 前置条件
  3. 步骤1:环境搭建
  4. 步骤2:核心实现
  5. 步骤3:...
  6. 完整代码(GitHub链接)
  7. 后续步骤 / 扩展

规则原因
先展示最终结果读者判断是否值得继续阅读
明确列出前置条件
避免浪费不相关读者的时间 | | 每个代码块都应可运行 | 复制-粘贴-运行是检验标准 | | 解释为什么而不仅是怎么做 | 解释原理的教程更易被分享 | | 包含错误处理 | 真实代码都有错误 | | 链接到完整代码仓库 | 教程后的参考依据 |

2. 深度解析 / 解释性文章

深入解释某个概念、技术或架构决策。

结构:

  1. 1. [概念]是什么,为什么值得关注?
  2. 工作原理(简化心智模型)
  3. 工作原理(详细机制)
  4. 真实世界示例
  5. 权衡取舍及何时不应使用
  6. 延伸阅读

3. 事后分析 / 事故报告

描述出了什么问题、原因以及如何修复。

结构:

  1. 1. 摘要(发生了什么、影响、持续时间)
  2. 事件时间线
  3. 根因分析
  4. 已实施的修复
  5. 防止再次发生的措施
  6. 经验教训

4. 基准测试 / 对比

基于数据的工具、方法或架构比较。

结构:

  1. 1. 我们比较了什么及原因
  2. 方法论(确保结果可复现)
  3. 带图表/表格的结果
  4. 分析(数字的含义)
  5. 推荐(附注意事项)
  6. 原始数据 / 复现说明

5. 架构 / 系统设计

解释系统如何构建以及决策背后的原因。

结构:

  1. 1. 需要解决的问题
  2. 约束和需求
  3. 考虑的方案
  4. 选择的架构(附图表)
  5. 接受的权衡
  6. 结果和经验

面向开发者的写作规则

语气和风格

应该不应该
直接表达:使用连接池您可能需要考虑使用...
承认权衡:这增加了复杂性
假装你的方案完美无缺 | | 团队决策用我们 | 我独自架构了... | | 具体数字:将p99从800ms降至90ms | 显著提升了性能 | | 引用来源和基准测试 | 提出无依据的主张 | | 承认替代方案 | 假装你的方案是唯一途径 |

开发者讨厌什么

❌ 在当今快速发展的技术世界中...(废话)
❌ 众所周知...(如果众所周知,为什么还要写?)
❌ 只需做X(如果你在读教程,说明并不简单)
❌ 这很容易...(轻视读者的经验)
❌ 显然...(如果显而易见,就别写了)
❌ 技术内容中的营销语言
❌ 用三段铺垫埋没核心观点

代码示例

规则原因
每个代码块必须可运行有问题的示例会破坏信任
展示完整、可工作的示例
脱离上下文的代码片段毫无用处 | | 在代码块中包含语言标识符 | 语法高亮 | | 在代码后展示输出/结果 | 读者验证理解 | | 使用真实的变量名 | calculateTotalRevenue 而非 foo | | 示例中包含错误处理 | 真实代码需要处理错误 | | 固定依赖版本 | 适用于 React 18.2 而非 React |

良好的代码块格式:

python

这段代码的作用(一行)


def calculateretrydelay(attempt: int, base_delay: float = 1.0) -> float:
带抖动的指数退避。
delay = base_delay (2 * attempt)
jitter = random.uniform(0, delay * 0.1)
return delay + jitter

使用示例

delay = calculateretrydelay(attempt=3) # ~8.0-8.8 秒

解释深度

读者信号深度
X入门解释一切,假设无前置知识
高级X模式
跳过基础,深入细节 | | X vs Y | 假设熟悉两者,聚焦差异 | | 我们如何构建X | 技术受众,可跳过基础 |

在开头明确说明假定的读者水平:

本文假设读者熟悉Docker和基本Kubernetes概念。
如果您是容器新手,请从[我们的入门文章]开始。

博客文章结构

理想结构

markdown

标题(包含主要关键词,陈述成果)

[题图或图表]

摘要: [2-3句话总结,包含关键要点]

问题 / 为什么重要

[说明读者为什么应该关注——具体而非泛泛]

解决方案 / 我们如何做到的

[核心内容——代码、架构、解释]

步骤1:[第一步]

[解释 + 代码 + 输出]

步骤2:[第二步]

[解释 + 代码 + 输出]

结果

[数字、基准测试、成果——要具体]

权衡和限制

[诚实地说明缺点——建立信任]

结论

[关键要点 + 下一步做什么]

延伸阅读

[3-5个相关链接]

各类型字数

类型字数原因
快速技巧500-800一个概念,一个示例
教程
1,500-3,000 | 分步指导需要细节 | | 深度解析 | 2,000-4,000 | 全面探索 | | 架构文章 | 2,000-3,500 | 图表分担部分内容 | | 基准测试 | 1,500-2,500 | 数据和图表承担主要工作 |

图表和视觉元素

何时使用图表

场景图表类型
请求流程时序图
系统架构
方框箭头图 | | 决策逻辑 | 流程图 | | 数据模型 | ER图 | | 性能对比 | 柱状/折线图 | | 前后对比 | 并排图 |

bash

生成架构图


infsh app run infsh/html-to-image --input {
html:

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 technical-blog-writing-1776332536 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 technical-blog-writing-1776332536 技能

通过命令行安装

skillhub install technical-blog-writing-1776332536

下载

⬇ 下载 technical-blog-writing v0.1.5(免费)

文件大小: 5.83 KB | 发布时间: 2026-4-17 16:20

v0.1.5 最新 2026-4-17 16:20
technical-blog-writing 0.1.5

- Added detailed SKILL.md describing technical blog writing structure, conventions, and best practices for developer-focused content.
- Included clear post type templates (tutorials, deep dives, benchmarks, postmortems, architecture).
- Outlined writing rules, code example guidelines, explanation depth, and developer audience engagement patterns.
- Provided sample CLI usage instructions and install notes for [inference.sh](https://inference.sh).
- Listed word count ranges, structural templates, and diagram usage recommendations for different post types.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large