用途:这是一个专注于用户向技术文档生成的专用技能(skill_id: user-guides,领域为技术文档),负责根据输入生成教程、入门指南、功能指南、故障排查和 FAQ 等文档。
主要能力:支持六种指南类型:getting_started、tutorial、feature_guide、troubleshooting、faq、reference。可接受产品名称、版本、功能列表、已有文档、UI 截图等内容来源;可指定目标读者(初学者/中级/高级/混合);支持 markdown、html、rst、docx 输出格式;可配置是否包含截图、故障排查、FAQ、后续步骤,以及章节数、每章步骤数、标题样式、编号步骤等结构选项。
输出与质量:返回内容(标题、章节、完整文档)、结构元数据(章节数、总步骤数、字数、预计阅读时间)、质量指标(可读性、清晰度、完整性、无障碍性评分,均 0-100),以及校验结果(问题与建议)和执行元数据。内置入门、教程、故障排查三类模板,并含参数校验规则、重试逻辑、日志与可观测性钩子、单元测试模板及问题排查指南。
使用方式:需提供 guide_type 与 source.product_name(必填,长度 2–100);audience 默认 mixed,output_format 默认 markdown,max_sections 默认 10(1–50),quality.min_reading_level 默认 8(弗莱什-金凯德年级,1–18)。技能状态标注为 Production-Ready,测试覆盖率 95%,质量门槛为可读性 70+。
适用场景:为产品编写首次上手步骤、教学式教程、功能说明、故障诊断手册,或整理常见问题与参考文档。
限制:官方未提供具体的收费、价格、平台支持范围及实际效果数据,暂未提供;输入校验失败会抛出 ValidationError,指南生成失败会抛出 SkillExecutionError(GUIDE_GENERATION_FAILED),并要求为每个步骤给出预期结果、避免未加说明的术语与过时截图。