SuperAPI AI 工具集

component-writeup

写作与研究

查看项目

更新于 10-15 20:05

技能介绍

用途:为指定系统(项目目录、子系统或一组制品)生成结构化技术文档,回答操作者指定的受众与问题。若只给出名称或模糊引用,需先索取制品路径,否则无法产出有证据支撑的文档。

主要能力:分三阶段推进。阶段一为就绪与发现:验证制品可访问性,盘点每个组件(名称、类型、功能、输入、输出),识别组件间关系(依赖、消费、触发、共享状态),梳理执行管线(入口、决策点、拦截点、终点),并以结构化表格输出清单。阶段二为分析与综合:合成架构(组织方式、承重组件、主导交互模式),按编号追踪主数据流,收集设计理由。阶段三为制品产出:按 references/component-writeup-template.md 的 Patnaik 渐进式披露模板渲染,包含开场钩子、设计理由、组件清单、架构概览(含 ASCII 框图与数据流)、逐组件细节、时序图、扩展点、运维清单、要点与参考。

使用方式:由操作者提供目标系统与制品路径,技能读取制品后按阶段执行,每阶段结束设门禁检查(组件是否齐全、关系是否完整、是否有孤立组件),通过后再进入下一阶段。

适用场景:需要基于真实代码、配置、技能、钩子、规格与文档产出可追溯技术文档的工程团队。

限制:所有结构性论断必须锚定制品证据,示例须取自目标实际制品;理由不可见时标注未知而非编造;文档只描述系统现状,除操作者明确要求外不提出改进或重设计建议。具体安装命令与收费信息暂未提供。