技术博客写作
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_1245903d/tech-blog-write。
技能介绍
解决什么问题
写技术博客最常见的翻车现场:开头一句「本文将介绍……」,读者已经划走了;段落动辄十几句,术语全是黑话,代码片段缺 import 跑不起来,结尾一句「希望对大家有帮助」草草收场。等到要交付 Word 文档时,还得手工粘贴、逐条调样式,一套流程下来写作热情所剩无几。这套规范就是把这些反复出现的坑,逐条固化成可执行的约束。
它如何工作
技能把写作拆成五个维度,缺一不可:
- 结构:标题必须包含核心关键词;开头用反直觉观点或痛点制造好奇心缺口,禁止「首先让我们来了解」式开场;正文每段不超过 5 句话,术语首次出现立即用通俗语言解释,代码示例完整可运行(含
import、配置与边界处理);结尾给出清晰总结加具体行动建议。 - 风格:口语化,像朋友聊天;禁用「首先、其次、最后、综上所述」等机械连接词;用具体数字和实例替代「很多、非常、一些」这类模糊程度词。
- 格式:全程 Markdown;代码块必须标注语言(如 ```python);核心结论用 粗体 强调。
- 输出:从标题第一行开始直接输出正文,不出现「好的,我来写一篇」之类的元语言。
- 交付:成稿后立即执行 Word 导出:写入临时文件
_blog_temp.md,调用scripts/md_to_docx.py转换,删除临时文件,再展示生成的 .docx。脚本负责标题层级、粗体、行内代码、代码块、列表、引用等格式映射,文件名由标题关键词生成(如PyTorch入门指南_从Tensor到训练.docx)。
每篇成稿前还要过一遍 11 项自查清单,从「开头有没有反直觉观点」到「Word 是否已导出并展示」,逐项确认后才允许交付。
适用边界与注意点
这套技能约束的是写作与交付流程,不负责生成技术选题或事实内容,技术准确性仍需作者自己把关。另外几点值得留意:
- Word 导出是强制步骤,若你的工作流只需要 Markdown,需要自行调整交付环节。
- 转换依赖
python-docx,首次运行前需确保依赖已就绪。 - 代码块的语言标注必须准确,否则无法映射到 Word 样式。
- 术语解释、模糊词替换这类规则依赖逐条执行,遇到高密度技术内容时,先跑一遍自查清单再交付更稳妥。
使用场景
- 技术团队需要为新功能撰写含代码示例的博客并导出Word文档交付
- 开发者在CSDN发布教程时需确保术语解释和代码可运行性符合规范
- 产品文档工程师要将复杂技术方案转化为口语化博客并生成.docx
- 开源项目维护者需要撰写含反直觉开头的PR介绍博文并导出Word
适合人员
- 技术团队负责人:需要统一团队技术博客的写作风格和交付格式
- CSDN/掘金博主:希望提升文章完读率和专业度的个体创作者
- 技术文档工程师:需要将内部文档转化为对外可读的博客文章
- 开源项目维护者:需要撰写专业且规范的PR介绍和功能说明