技术博客写作
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_1f949bb0/tech-blog。
技能介绍
要解决什么问题
技术博客常卡在「结构松散、开头像说明书、代码不能跑、段落堆成墙」——读者扫两眼就关页,你也难复盘自己到底写了什么。本技能把写作流程和可检查的规范绑在一起,让 Agent 按同一套标准产出可直接落盘的 Markdown 稿,而不是泛泛的「帮我写篇文章」。
技能如何工作
流程分两步:先明确写作内容(主题、读者、要覆盖的要点),再按规范生成正文。
内容结构上要求:
- 标题:短、有力,带核心关键词
- 开头:用反直觉观点或具体问题抓人,避免「首先让我们来了解…」
- 正文:单段不超过 5 句;专业术语首次出现要解释;代码示例必须可运行
- 结尾:归纳要点,并给出可执行的下一步
格式统一为 Markdown:代码块标注语言,关键结论用粗体。成稿保存在当前项目目录,文件为 .md 格式(由你与 Agent 在写作前约定具体文件名)。
适用边界与注意点
它管的是「怎么写成一篇像样的技术文」,不负责选题调研、SEO 关键词堆砌或发布到 CMS。若你的仓库没有约定输出路径或命名规则,需要在第一步把文件名和存放位置说清楚,否则容易和项目里已有文档冲突。规范里的段落长度与可运行代码是硬约束,复杂架构文可能需要你主动拆成多节或多篇。
使用场景
- 在仓库里写功能教程,要求段落简短、术语首次解释且示例代码可直接运行
- 把架构决策或排障过程整理成对外技术文,开头用具体问题而非套话引入
- 团队约定博客稿统一落在项目目录的 `.md`,需要按标题—正文—结尾模板一次性成稿
- 修订旧文档时发现结构混乱,需要按「反直觉开头 + 可执行结尾」重写成新稿
适合人员
- 维护开源项目的核心开发者,需要把新特性写成可收录进仓库的 Markdown 教程
- 负责内部技术宣贯的工程师,要把复杂机制写成同事愿意读完的博文式说明
- 技术布道者或开发者关系,要在成稿前先对齐主题与读者再按规范输出全文
- 写个人技术博客的独立开发者,希望 Agent 按同一套段落与代码规范落盘到当前项目