SuperAPI AI 工具集

make-blog-post

写作与研究

查看项目

更新于 10-16 12:03

技能介绍

用途

Make Blog Post 是一个面向代码作者的写作辅助技能,用于把当前会话中已经写好的代码转成一篇博客文章,并且读起来像是代码作者本人写的。它围绕一个函数、脚本、类或工具做一次聚焦的讲解,配一个通用化示例和一个使用示例。

它只在用户主动要求写文章时运行。合适的触发时机是代码已经可以工作的回合末尾,调用 /make-blog-post,后面可以可选地说明要写什么、文章放在哪里,以及作者过往文章的链接或文件。

主要能力

  • 从当前会话写出或改动的代码中挑选一个主题,也可以使用用户指定的函数、文件、选区、代码片段或话题,包括粘贴到对话里的代码。
  • 判断主题是否适合作为独立文章:应解决一个清晰、通用的问题,能放进一个自包含的示例中,不依赖无法用占位符替代的项目专有状态、服务或配置,并且不应该是琐碎的一行包装或孤立的标库调用。任一检查不通过时会指出是哪一项,并建议可行的角度,例如围绕代码背后的技术。
  • 解析发布目标:可以写入用户指定的本地路径、当前工作区仓库、gist 之类的发布场所,或者仅在聊天中展示。
  • 学习作者文风:按顺序从请求中指定的样本、用户指向的已保存文风档案、博客仓库 posts 文件夹中该作者最近的文章收集三到五个样本,并据此建立文风档案。
  • 在起草前给出计划供用户确认,计划包括主题与单一目的、发布目标的完整路径、文风来源与摘要、工作标题、slug、SEO 级别,以及待决问题。
  • 起草后完整展示,邀请修改,直到用户明确批准。
  • 交付:写入文件时使用站点格式、宿主路径分隔符和仓库行尾;在聊天中交付时按复制粘贴规则;也可以按手动发布渠道组织文章并列出字段值。

使用方式

触发形式为 /make-blog-post,可带可不带参数。示例:

  • /make-blog-post
  • /make-blog-post the retry helper in src/http.ts
  • /make-blog-post the slugify function, as a gist
  • /make-blog-post put it in the blog, match https://example.com/posts/one and https://example.com/posts/two

工作流程按顺序执行,在计划通过前不会写入磁盘。起草并展示文章不需要批准,但在得到明确同意前不会保存到文件、发布、提交或推送。写入命名路径时,会在已存在的根目录下创建缺失的子文件夹;如果根目录本身不存在,会先询问而不是冒险创建可能是笔误的目录树。

适用场景

适用于把代码写成博客文章、文章、教程、讲解或 gist 的场景。不适用于 API 参考、README、变更日志、发布说明,也不适用于需要多个不相关示例或多文件讲解的文章。

文章包含:标题指明代码解决的问题;简短开头说明代码的作用和覆盖的单一用例;一个代码块中的通用化函数、方法或工具;带常见示例数据和预期输出的最小使用示例;如有值得说明的限制或边缘情况,则加一段结尾说明。实现及其用法算作一个完整示例,语言允许时可以共用同一个代码块。

默认文章布局使用 YAML front matter,包含 title、description、slug、category、tags、date 字段,但站点自身的 front matter 优先。不解析 front matter 的发布目标不会得到这个区块。

限制

  • 一篇文章、一个目的、一个完整示例。
  • 完整匹配文风至少需要三个样本;样本更少时档案是简化或中性的,计划检查会说明这一点。
  • 该技能会写文件,但不会发布、上传、提交或推送。
  • 安全与内容规则适用于进入文章的一切内容:不得包含凭证或安全数据,示例数据只能用老套的通用值,不得包含工作上下文或样本中的附带细节,代码需要重写而不是复制,样本中的路径遵循样本平台,公开署名和公开技术保留真实名称。
  • 缺少事实的部分(如具体价格、收费、平台、效果或未提供的使用步骤)暂未提供。