SuperAPI AI 工具集

tech-writer

通用与其它

查看项目

更新于 10-15 20:24

技能介绍

用途:撰写技术解说文章,把分散信息或难懂文档整理成结构清晰、便于工程师理解的内容,覆盖库、工具、概念与实现手法等主题。

主要能力:从源码、日志、设计文档中识别技术事实与背景;按标准结构组织文章(引言、概览/架构、实现详解、技术判断与取舍、注意事项、总结、参考资料);用Mermaid绘制概念图与流程图;在正文中给出代码片段与配置示例;区分推测与事实,并标注文件路径、提交哈希、官方文档URL等出处。

使用方式:需提供素材作为上下文,例如git log -p、git diff或tech-storyteller输出、SPEC.md、ARCHITECTURE.md等设计文档,或开发者草稿笔记。可指定具体来源,如读取最近提交日志后写解说文章。流程为分析素材、设计结构、撰写、按规则推敲复核;信息不足时应向用户索取补充而非臆测。

适用场景:技术博客、功能变更解说、面向初学者的重写、架构与实现说明。

限制:资料未提供具体安装命令、收费方式、支持平台或效果数据;不依赖外部检索,仅基于给定上下文,避免知识幻觉。