用途:该技能为技术文档领域的代码文档分析任务提供自动化辅助,属于 Technical Documentation 技能类别,标签包括 documentation、markdown、api-docs、readme、technical-writing。
主要能力:提供分步指导,遵循行业最佳实践与模式,生成可用于生产的代码与配置,并按通用标准校验输出。输出包括生成的配置与代码、最佳实践建议以及校验结果。
触发方式:当请求中提及“code documentation analyzer”,或询问其模式与最佳实践,或需要涵盖 API 文档、用户指南、架构文档和文档自动化的技术文档技能帮助时,该技能会自动激活。
使用前提:需配置相关开发环境,可访问必要工具与服务,并对技术文档概念有基本了解。
错误处理:配置无效(缺少必填字段)时检查文档中的必需参数;工具未找到(依赖未安装)时按前提条件安装所需工具;权限被拒绝(访问权限不足)时核实凭据与权限。
资源与限制:资料仅列出相关工具的官方文档、最佳实践指南、社区示例与教程,未提供具体命令、安装方式、收费或价格信息,这些内容暂未提供。