专业技术博客写作工具,覆盖技术教程、项目复盘、工具推荐、踩坑记录等各类技术文章类型。提供Markdown格式规范、结构化写作方法、代码示例规范,帮你写出专业、有深度、能帮助他人的技术文章。适用于程序员、技术博主、知识分享等OPC场景。
【适用场景】
场景一:技术教程撰写
当你想写一篇编程教程,教别人怎么用某个技术时。工具帮你设计教程结构,从基础到实践,让读者能跟着操作。场景二:项目复盘记录
当你想记录一个项目的开发过程、遇到的问题和解决方案时。工具帮你组织复盘结构,让记录有价值。场景三:工具推荐文章
当你想推荐一个好用的开发工具或库时。工具帮你设计推荐文章的框架,从介绍到实践。场景四:踩坑记录
当你想记录一个bug的排查和解决过程时。工具帮你写成一篇有价值的踩坑记录。【操作步骤】
第一步:明确文章类型
告诉工具: - 文章类型(教程/复盘/推荐/踩坑) - 目标读者是谁 - 技术深度要求
第二步:设计文章结构
教程文章结构: 1. 引言:介绍这是什么、解决什么问题 2. 前置知识:读者需要什么基础 3. 环境准备:安装和配置 4. 核心内容:分步骤讲解 5. 实践案例:一个完整的例子 6. 总结与延伸:回顾要点、延伸学习
踩坑记录结构: 1. 问题描述:发生了什么 2. 环境信息:什么环境下的 3. 排查过程:怎么一步步排查的 4. 解决方案:最终怎么解决的 5. 总结:以后怎么避免
第三步:撰写代码示例
代码示例规范: - 代码块标注语言 - 关键行加注释 - 复杂代码分段解释
【代码模板】
教程模板
```markdown
[教程标题]
前言
[介绍本文要解决的问题和适合的读者]环境准备
```bash安装命令
```第一步:[标题]
[说明] ```代码代码示例
```第二步:[标题]
[同上结构]实战案例
[完整项目或练习]总结
[回顾要点] ```【复盘要点】
技术博客写作原则
1. 读者视角:想象读者是谁,他们需要什么 2. 循序渐进:从简单到复杂,让读者能跟上 3. 代码规范:代码要能跑,注释要清晰 4. 图文并茂:适当配图(架构图、流程图、截图)
常见问题
1. 太基础或太高级:明确读者群体 2. 代码不能跑:写完后自己验证一遍 3. 逻辑跳跃:每一步都要有承接
来源:GitHub https://github.com/kevinaimonster/skill-hub