SuperAPI AI 工具集

write-guides

写作与研究

查看项目

更新于 10-16 09:50

技能介绍

用途:为 Remix 指南章节(尤其是 docs/guides/app/actions/docs/chapters/*.md)撰写、重写和审校文字。目标是让指南读起来像有人带着读者走查真实 Remix 代码:具体、直接、略带口语,示例严谨;避免空泛填充、重复结论和可套用于任何框架的抽象说法。\n\n使用前:先读 01-start-here.md 把握语气与示例风格;完整读目标章节;若目标章节引用前后概念,读相邻章节;若章节解释 Remix 应用代码,先加载 remix 技能或相关 Remix 参考资料再发明模式。若只要求识别 AI 腔文字,报告行号与发现,除非被要求否则不编辑。\n\n语气:以读者刚做或下一步要做的事开头;使用具体文件、URL、路由、handler、组件和响应;走查步骤用 we,读者可控的选择用 you;段落短小,一段一个观点;先给代码再立即解释,但不逐行叙述;让示例承担解释;文件角色、路由展开、上下文字段等密集事实用小列表;需要展开的话题链接到其他章节,但不以链接代替本地解释。章节开头可设定范围,但必须点明具体文件、API 或阶段。\n\n避免的 AI 腔:具体内容前的抽象主题句;seamlessly、robust、powerful、unlock 等泛化词;示例前后重复同一观点;一连串短句定义相邻的显而易见部分;Additionally、Furthermore、It is important to note 等软过渡;thing、stuff、pieces 等占位名词;过度保证如“TypeScript 会告诉你每一处”“失败很响”;可属于任何框架的通用 Web 建议;重述章节的总结段落。\n\n结构与示例:按学习顺序组织,先讲显式形状再讲辅助简写,边界情况放最后;指南与 API 概览区分开,只教理解指南所需的语法,完整语法链接到 API 概览;保留 frontmatter 标题与描述(除非范围变化);保留其他章节已链接的显式标题锚点;示例从 remix/... 导入而非 @remix-run/...;相对导入使用 TypeScript 扩展名;片段内部一致,导入齐全、无未用导入、命名匹配;优先使用现有 albums 记录存储示例;链接、重定向、表单和测试用 routes.<name>.href(...);action 返回显式 Web Response;用 // inside an action: 之类短注释标明不完整片段。\n\n锚点:默认用生成锚点,仅保留既有链接锚点或有意指定时加 {#anchor};改动或删除标题锚点前用 rg "#anchor-name" guides packages 搜索入链;跨章节链接沿用指南现有的 /docs/... 风格。\n\n工作流:审校 AI 腔时按模式分组、引用触发短语、解释原因、只给改写方向;重写时保留有用技术与示例、删除重复结论和通用过渡、用具体文件或 API 替换抽象框架、必要时重排章节、修复示例漂移、再对照 01-start-here.md 调整语气,然后运行 pnpm exec prettier --check <path-to-chapter.md>,仅在预期且可接受格式变化时用 pnpm exec prettier --write <path-to-chapter.md>。\n\n限制:资料未提供该技能的安装方式、收费、价格、平台与效果信息。