SuperAPI AI 工具集

technical-blog-writing

写作与研究

查看项目

更新于 10-15 11:42

技能介绍

技术博客写作(Technical Blog Writing):面向开发者受众的技术博客文章写作技能,通过 inference.sh CLI 完成写作辅助。

用途 面向开发者读者撰写技术博客文章,强调结构、代码示例与开发者受众惯例,覆盖文章类型、代码格式、讲解深度与发布分发。

安装与前置 安装 belt CLI 技能:

npx skills add belt-sh/cli

需要 inference.sh CLI(belt),安装说明见产品说明。登录:

belt login

可通过 CLI 调用检索话题深度,例如:

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

生成头图:

belt app run infsh/html-to-image --input '{...}'

生成架构图:

belt app run infsh/html-to-image --input '{...}'

生成基准图表:

belt app run infsh/python-executor --input '{...}'

跨平台发帖:

belt app run x/post-create --input '{...}'

(上述命令中的完整 HTML/代码负载见产品说明。)

文章类型

  1. 教程/操作指南(Tutorial / How-To):逐步说明,读者应能跟随并做出东西。结构包括:要构建什么(含截图/演示)、前置条件、步骤1 搭建、步骤2 核心实现、后续步骤、完整代码(GitHub 链接)、下一步/扩展。规则:先展示最终结果;明确列出前置条件;每个代码块应可运行;解释“为什么”而不只是“怎么做”;包含错误处理;链接到完整代码仓库。
  2. 深度解析/解释文(Deep Dive / Explainer):深入解释概念、技术或架构决策。结构:什么是[概念]、为何值得关注、简化心智模型、详细机制、真实案例、权衡与不适用场景、延伸阅读。
  3. 事故复盘/事件报告(Postmortem / Incident Report):描述出了什么问题、原因与修复。结构:摘要(发生了什么、影响、持续时长)、事件时间线、根因分析、已实施修复、防止复发的措施、经验教训。
  4. 基准/对比(Benchmark / Comparison):数据驱动的工具、方法或架构对比。结构:对比什么及原因、方法论(结果可复现)、结果(图表/表格)、分析、建议(含注意事项)、原始数据/复现说明。
  5. 架构/系统设计(Architecture / System Design):解释系统如何构建及决策原因。结构:需解决的问题、约束与需求、考虑过的选项、选定架构(含图)、接受的权衡、结果与经验。

开发者写作规则 语气与风格(Do):直接表达(如“使用连接池”);承认权衡(“这增加了复杂性”);团队决策用“we”;用具体数字(“p99 从 800ms 降到 90ms”);引用来源与基准;承认替代方案。 不推荐的写法(Don't):模糊措辞(“你或许可以考虑……”);假装方案完美;自我中心(“我独自设计了……”);笼统描述(“显著提升性能”);无来源断言;假装是唯一方案。 开发者讨厌的写法:填充语(“在当今快节奏的技术世界……”)、“众所周知……”、“只需做 X”、“很容易……”、“显然……”、技术内容中的营销语言、把重点埋在三段上下文之后。

代码示例规则 每个代码块必须可运行;展示完整可用示例;围栏代码块中包含语言标识;代码后展示输出/结果;使用真实变量名(如 calculateTotalRevenue 而非 foo);示例包含错误处理;固定依赖版本(“适用于 React 18.2”而非“React”)。 好的代码块格式示例(含:代码作用一行说明、函数、文档字符串、指数退避加抖动、使用示例与注释结果)。

讲解深度 按受众信号确定深度:入门(解释一切、假设无先验知识);进阶模式(跳过基础、深入细节);X 与 Y 对比(假设熟悉两者、聚焦差异);我们如何构建 X(技术受众、可跳过基础)。在开头明确说明假设的读者水平,例如:“本文假设你熟悉 Docker 和基本 Kubernetes 概念。如果你是容器新手,请从我们的入门文章开始。”

博客文章结构(理想结构) 标题(含主要关键词、说明成果);主图或图;TL;DR(2-3 句总结含关键结论);问题/为何重要(具体而非笼统);解决方案/我们如何做(核心内容:代码、架构、解释,分步骤:说明 + 代码 + 输出);结果(数字、基准、成果,要具体);权衡与限制(诚实说明缺点,建立信任);结论(关键结论 + 下一步);延伸阅读(3-5 个相关链接)。

按类型的字数参考 快速提示 500-800(一个概念、一个示例);教程 1,500-3,000(循序渐进需要细节);深度解析 2,000-4,000(充分探索);架构文章 2,000-3,500(图示承担部分说明);基准对比 1,500-2,500(数据与图表做主力)。

图表与可视化 何时使用图:请求流—序列图;系统架构—方框箭头图;决策逻辑—流程图;数据模型—ER 图;性能对比—柱状/折线图;前后对比—并排展示。 生成架构图与基准图表示例见产品说明中的 belt 命令。

分发 开发者阅读的地方:自有博客(完整文章,主渠道,拥有内容);Dev.to(交叉发布,canonical URL 指回自有博客,Markdown 导入);Hashnode(交叉发布,canonical URL,Markdown 导入);Hacker News(链接提交;Show HN 用于项目,Tell HN 用于故事);Reddit(r/programming、r/webdev 等,链接或讨论,遵守子版规则);Twitter/X(串推摘要 + 链接,参见 twitter-thread-creation 技能);LinkedIn(改写版本 + 链接,参见 linkedin-content 技能)。跨平台发帖命令见产品说明。

常见错误 无 TL;DR(忙碌开发者未看到要点即离开)→ 顶部放 2-3 句摘要;代码示例损坏(摧毁可信度)→ 发布前测试每个代码块;未固定版本(代码半年后失效)→ “适用于 Node 20、React 18.2”;“只需做 X”(居高临下)→ 去掉“只需”“只要”“轻松”;架构无图(大段文字描述系统)→ 一张图 > 500 字描述;营销语气(开发者立即脱退)→ 直接、技术、诚实;无权衡章节(读起来像有偏营销)→ 始终讨论缺点;内容前有冗长引言(读者流失)→ 2-3 段内进入正题;依赖未固定(教程对后续读者失效)→ 固定版本并注明写作日期;无“延伸阅读”(死胡同、无上下文)→ 3-5 个链接深化理解。

相关技能 npx skills add inference-sh/skills@seo-content-brief npx skills add inference-sh/skills@content-repurposing npx skills add inference-sh/skills@og-image-design

浏览所有应用:belt app list。

限制:关于收费、价格、平台支持范围、写作效果等事实,资料中未提供,暂未提供。