使用 GitHub 问题查看文档
参与 Microsoft Learn 最有用的方法之一是直接提供有关文档文章的反馈。 使用页面上的反馈链接,可以在浏览过程中提出编辑、建议、问题或其他见解。 由于大多数 Microsoft Learn 文档内容都存储在 GitHub 存储库中,因此可以使用称为“提交 GitHub 问题”的 GitHub 流程提供反馈。
GitHub 中的问题是一种工具,使技术用户、工程师和其他 Microsoft Learn 访问者能够分享和跟踪特定文章的反馈。 填写表单以记录反馈,并将其发布到 GitHub 中的源文章存储库,作者或所有者将收到通知。 访问 GitHub 存储库的任何人都可以看到问题。 它们是收集和存储有价值的反馈(例如报告 bug、功能请求或注释)的有用方法。
为什么要在 GitHub 中评审内容?
在 GitHub 上提供内容评审是参与你热衷或了解的主题的直接方法。 这意味着,在浏览 Microsoft 文档中的主题时,可以添加想法。 为知识池提供见解有助于改善数百万其他用户的 Microsoft 产品体验。 你的反馈为依赖 Microsoft 产品及其支持内容的其他 Microsoft Learn 访问者提供了内容。
在大多数情况下,提交 GitHub 反馈可让你将自己的想法发送给负责产品内容集的团队。 内容团队与产品用户之间的这种协作路径允许直接在 GitHub 中共享和讨论反馈。
参与文档内容也可以为你提供专业优势。 GitHub 是一个知名平台,可在其中做出和跟踪技术贡献。 每次在 GitHub 上参与项目时,它都会反映在你的 GitHub 个人资料中。 随着时间的推移,可以建立自己的参与记录,以添加到技术组合中。
如何提供有关内容的反馈
回想一下,Microsoft Learn 上的许多文档文章都存储在 GitHub 存储库中。 许多 GitHub 存储库都启用了 GitHub 问题。 启用后,可以在 learn.microsoft.com 上的文章底部找到提交针对此页面的反馈的选项。
若要创建和提交问题,需要有 GitHub 帐户。 下面介绍如何从 Microsoft Learn 文章提交 GitHub 问题:
登录到 GitHub 帐户。
导航到想要提供其反馈的 Microsoft Learn 文档文章。
在文章底部,找到标有“反馈”的标题。 在这里,你可看到一个标有“此页面”的框。
- 若要提供有关文章本身的反馈,请选择“此页面”。 这会转到 GitHub 上的空白问题表单,可以在其中开始填写评论。 你现在将选择此选项。
- 如果要查看针对该主题提交的其他 GitHub 问题,请选择“查看所有页面反馈”。 任何人都可以读取公共存储库中的其他 GitHub 问题,并且如果你有 GitHub 帐户,也可以对问题发表评论。
- 通过选择“此产品”,可以提供有关产品本身的反馈。 我们暂时不会详细介绍此选项,因此我们可以专注于提供有关文档本身的反馈。
选择“此页面”后,系统会提示你登录到 GitHub 帐户(如果尚未登录)。 然后,GitHub 中会显示一个空白的问题反馈表单。
输入反馈的标题,简要总结你的输入。
在下面的文本框中,描述你的反馈并提供任何必要的上下文。 使用工具栏设置描述格式,例如添加引用、列表或提及。
完成后,选择“提交新问题”。
跟踪问题
提交问题时,文章的作者或其他内容所有者会收到通知。 可以通过查看 GitHub 通知或返回到存储库并查看“问题”选项卡来跟踪有关问题的评论。
还可以在“问题”选项卡中浏览、查看和评论针对该存储库提交的其他问题。