用途:该技能面向技术文档领域,提供 api reference creator 相关任务的自动化辅助,覆盖 API 文档、用户指南、架构文档与文档自动化等场景。
主要能力:提供分步指导,遵循行业最佳实践与模式,生成可用于生产的代码与配置,并按常见标准校验输出;同时给出最佳实践建议与校验结果。
使用方式:当请求中出现“api reference creator”,或询问其模式与最佳实践,或需要技术文档相关帮助时,技能会自动激活。示例请求为“Help me with api reference creator”,返回分步指导并生成相应配置。
适用场景:编写 API 参考文档、整理用户指南与架构文档、推进文档自动化流程。
限制与前提:需要配置相关开发环境、可访问必要工具与服务,并具备技术文档基础概念。资料未提供具体安装命令、价格、平台支持范围或效果数据。错误处理方面,配置无效时检查必填字段,工具缺失时按前提安装依赖,权限不足时核对凭据与权限。相关资源包括官方文档、最佳实践指南与社区示例。标签:documentation、markdown、api-docs、readme、technical-writing。