跳到正文

报告文档问题

用页面位置、对应版本、实际结果和期望结果提交可复查的 Issue。

选择提交位置

从项目目录确认中文仓库和原文来源。译文误解、中文站的损坏链接和本地化页面的显示问题可以在中文仓库讨论。原文和实际行为也有差异时,在报告中写清上游版本并链接原文。站内规范的建议可以在简中文档的议题列表查找相近主题。

先按页面名、错误消息或版本号搜索已有讨论。已有议题描述同一现象时,可以补充新的受影响版本、复现条件或最小示例。

把问题缩到能复现的一处

“安装教程有问题”可以改为“安装指南的首次运行缺少生成配置的步骤”。把页面链接指向正确的小节,再写明刚执行的命令、预期看到的状态和实际结果。涉及译文时,选择一小段上下文,说明改变了哪个条件、单位或操作顺序。

日志保留能判断问题的字段即可。将私有地址、账号和凭据替换为示例值,保留状态码、字段名和版本号。如果只能在特定浏览器或系统看到问题,写明窗口宽度、系统和浏览器版本。

Issue 模板

## 位置

页面链接、具体小节、中文版本。涉及译文时附上游提交或版本。

## 实际结果

按页面执行的步骤和能看到的错误或输出。

## 预期结果

按描述应看到的状态,以及你建议补充的信息。

## 可复查的环境

相关的系统、工具版本、配置或最小输入。

报告涉及多个无关页面时,按问题拆分。已有改法时,可以用一两句解释修改如何解决问题,再提交拉取请求。