最近更新时间:2025-06-03 14:52:37
文档捉虫类活动按照提交的文档缺陷级别来计算积分。文档缺陷级别分为4个大类、3个等级,以下为详细定义,具体定级以金山云审核过程中的专业人员给出的意见为准。
1、如问题无法定位、无法复现,则会被认定为不通过,请尽量描述清晰,必要时可以配以截图方便审核人员定位。
2、不再维护的文档、手机端文档问题、英文文档问题不在本次活动范围内,敬请谅解。
3、非代码模块的英文字母大小写问题不在验收范围内。
4、非代码模块的标点符号问题不在文档捉虫活动范围。
5、图片中与正文描述无关的信息不在验收范围内。
6、对于界面上有明确引导提示的操作比如“确定”、“确认”、“OK”等,如果文档中存在缺失或差异,不在验收范围内。
P1错误:内容严重错误、缺失,影响操作中断。
P2错误:内容有误或不完整,不影响操作。
P3错误:不规范和低错类。
错误类型 | 二级分类 | 定义 | 级别 |
|---|---|---|---|
描述不准确 | 内容错误 | 文档存在与事实、技术规范或用户实际需求不符的信息,可能导致误解、操作失误或对产品功能的错误认知 | P1 |
缺少备注说明 | 文档未对功能的限制条件、特殊场景、兼容性要求或潜在风险等进行必要的补充说明,可能导致用户操作失败或理解偏差 | P2 | |
错字病句、拼写错误 | 文档存在错字、病句或拼写错误 | P3 | |
语义歧义 | 文档存在用词不当、专业术语不规范、逻辑不清等问题,易出现内容理解上的偏差或歧义 | P3 | |
描述冗余 | 文档存在不必要、重复或过度解释的内容,这些信息对用户理解核心功能或完成操作没有实质性帮助,反而会增加理解难度 | P3 | |
功能缺陷 | 技术待升级 | 产品功能、接口、工具或依赖项存在技术迭代滞后或兼容性不足的问题,无法满足用户当前的技术环境或需求,亟待升级 | P1 |
信息缺失 | 文档缺失用户所需的必要信息,导致关键功能、操作步骤、参数说明或场景解决方案未被覆盖,影响用户的理解或操作 | P1 | |
文档与实际操作不一致 | 指令错误 | 文档中的命令、代码、配置参数、API调用示例或URL链接等具体操作指引存在错误,导致用户无法直接执行 | P1 |
引导不够详细清晰 | 文档在指导用户操作或理解功能时,存在逻辑不连贯、实例缺失、表述模糊或缺乏可视化辅助等问题,用户理解、操作难度大 | P2 | |
更新不及时 | 文档版本与产品实际版本脱节,产品功能、接口或服务已发生变更(如新增、废弃、优化),但相关文档未同步修订 | P2 | |
链接404 | 链接跳转显示404报错 | P3 | |
页面待优化 | 页面易崩溃 | 文档系统或页面在用户访问时易出现非预期的崩溃、卡死或无法正常加载的情况 | P1 |
导航出错 | 文档系统的导航结构(如目录树、侧边栏或搜索索引)存在层级混乱或定位不准的问题,无法通过导航快速定位到目标内容 | P1 | |
图片不清晰 | 文档中图片的清晰度不足,无法准确获取内容信息 | P2 | |
页面美化 | 文档在排版、格式、视觉呈现和结构布局等方面待优化 | P3 | |
隐私规范 | 文档中未对敏感信息(如IP地址、账号信息等)进行必要的脱敏处理,违反数据安全合规要求 | P3 |
错误类型 | 二级分类 | 内容描述: | |||
描述不准确 | 内容错误 | 文档存在与事实、技术规范或用户实际需求不符的信息,: | |||
功能缺陷 | 技术待升级 | 产品功能、接口、工具或依赖项存在技术迭代滞后或兼容性不足的问题,进行具体描述 : | |||
页面待优化 | 导航错误 | 档系统的导航结构(如目录树、侧边栏或搜索索引)存在层级混乱或定位不准的问题 | |||
纯净模式