Skip to content

问题反馈指南

如果你在阅读文档时发现问题（错误、过时、缺漏、看不懂），有两种方式可以反馈：

方式一：提交 GitHub Issue（推荐）

Issue 是 GitHub 上的问题追踪功能，适合报告文档中的错误或提出改进建议。提交 Issue 后，维护者会收到通知并及时处理。

如何提交 Issue

  1. 打开文档站仓库：https://github.com/GMasterEmbeddedGroup/GmasterDoc
  2. 点击顶部 Issues 标签页
  3. 点击绿色 New Issue 按钮
  4. 填写以下内容：

标题：简洁描述问题，例如 "CAN通信原理中波特率数据有误" 或 "嵌入式基础第5章缺少中断回调示例"

正文：包含以下信息—— - 哪个文件/章节有问题（贴上链接或路径） - 具体哪里写错了 / 看不明白 - 如果是错误：你期望的正确内容是什么 - 截图（可选，但有助于定位问题）

  1. 点击 Submit new issue 提交

Issue 示例

标题：GPIO与高低电平中推挽输出电路图标注有误

正文：
文件：嵌入式基础/03-GPIO与高低电平.md 第2.2节
问题：推挽输出结构图中，PMOS 和 NMOS 的通断状态标反了。
期望：输出高电平时 PMOS 应导通、NMOS 截止，图中标注相反。

Issue 提交后，维护者会尽快回复。如果你的建议被采纳，修改会通过 PR 合并到文档站。

方式二：直接联系文档作者

每份文档末尾都有作者的 GitHub 链接，点击即可进入作者主页，通过 GitHub 私信或其他联系方式提问。

建议优先使用 Issue，这样问题和解答对所有队员可见，避免重复提问。

方式三：自己动手修

如果你知道怎么改，可以直接按照 Git 工作流 提交 PR，维护者审核后合并。