你是否曾在使用开源项目时，被一份“天书”般的文档劝退？又或者，你火眼金睛，总能发现文档中的“小秘密”？现在，你的机会来了！香山社区正式启动「文档捉虫大作战」第一期，邀请所有热爱开源、乐于探索的你，一起为香山文档“找茬”，共同提升文档质量！
为什么我们要“捉虫”？
一份清晰、准确、易懂的文档，是开源项目蓬勃发展的基石。它不仅能帮助新用户快速上手，也能让资深开发者更高效地理解项目细节。本次活动，我们希望：
1. 提升文档可读性与准确性：通过社区成员的反馈，发现并优化文档中模糊、错误或过时的内容。
2. 鼓励社区深度参与：让更多人通过阅读文档，深入了解香山项目，并积极参与到社区贡献中来。
谁能参与？
无论你是：
● 开源社区的开发者、用户、文档贡献者
● 对香山项目感兴趣的技术爱好者
● 甚至是初次接触开源，但愿意阅读文档的新手
我们都张开双臂欢迎你！
无需经验，只要你有一颗“找茬”的心！
活动时间
2025年9月15日 至 2025年10月31日
活动进展与最终结果将在香山社区官网
（https://xiangshan.cc）公布
敬请关注！
“捉虫”目标文档
本次活动主要针对以下香山开源项目的中文和英文文档：
● 《香山开源处理器用户手册》
○ 文档链接：https://docs.xiangshan.cc/projects/user-guide
○ GitHub 仓库：https://github.com/OpenXiangShan/XiangShan-User-Guide
● 《香山开源处理器设计文档》
○ 文档链接：https://docs.xiangshan.cc/projects/design
○ GitHub 仓库：https://github.com/OpenXiangShan/XiangShan-Design-Doc
如何参与“捉虫”？
参与流程非常简单，只需几步，你就能成为香山文档的“守护者”！
第一步：了解文档
请仔细阅读上述列出的相关文档，熟悉其内容和结构。建议您选择自己感兴趣或擅长的部分进行深入阅读，以便更好地发现潜在问题。
第二步：认领任务
为了覆盖更多的文档，避免参与者的审阅范围产生重叠，本次活动采用先认领任务再提交贡献的模式。
●《香山开源处理器用户手册〉任务清单：
https://github.com/OpenXiangShan/XiangShan-User-Guide/issues/27
●《香山开源处理器设计文档》任务清单：
https://github.com/OpenXiangShan/XiangShan-Design-Doc/issues/88
如图所示。其中每个任务将对应一个文档文件。
在其中列出的文档列表中找到自己感兴趣的且未被认领的文档，随后按提示在此 Issue 下回复文档名以认领任务，如 docs/zh/introduction.md，随后在 Issue 下评论：
/claim docs/zh/introduction.md随后，机器人会自动将认领者的用户名加入文档列表中。工作人员也会定期检视 Issue 的回复，确保将认领者认领任务成功。
同一个任务可以被多人认领，我们仍然建议您选择未被认领的文档。
第三步：发现问题
在认领任务后，您就可以开始查找文档中的问题了，下面是一些典型的错误：
问题类型分类参考：
● 表述模糊或难以理解：文字描述不清晰，导致读者难以理解其含义。
● 技术错误或过时信息：文档中包含不准确的技术细节、代码示例错误或已过时的信息。
● 缺少关键说明或示例：某些概念或操作缺乏必要的解释或实际示例。
● 格式排版问题：文档布局混乱、排版不规范、图片缺失或显示，例如文档中出现了未被渲染的标识符、图片表格缺少标题、图片显示异常、排版格式混乱等
● 错别字：文字拼写错误、语法错误或标点符号使用不当。
● 翻译问题：译文与原文存在偏差、专有名词未被正确翻译等。
● 其他：上述分类之外的任何影响文档质量的问题。
关于详细的文档规范，请参考《香山文档贡献指南》（https://docs.xiangshan.cc/zh-cn/latest/contribution/documentation/）。
第四步：提交 Issue 报告问题
在发现问题后，您即可在对应的文档仓库提交 Issue 来详细报告您所发现的文档问题。提交 Issue 时，请选择 “Document Bug Report” 类型，并按照 Issue 模板的提示提供详细信息。
创建 issue 图示
issue 模板展示
提交后，请等待社区审核者的回复。审核者将对您提交的问题进行评估和确认。
如果您发现的问题较为简单，您也可以直接提交 Pull Request 进行修复。要求见下。
第五步：创建 Pull Request 修复问题
当您的问题被审核者确认并回复后，您可以根据审核者的建议，在您本地克隆的项目中进行修改，然后创建 Pull Request (PR) 提交您的修改。
提交 PR 时，请遵守以下注意事项：
● 请遵守 PR 标题规范，以 fix(part/chapter): fix something something 的格式填写标题
●请在 PR 中详细描述您所做的修改内容，例如：修复了第X页的错别字，更新了代码示例，补充了缺失的说明等
●在 PR 标题和描述中均使用英语
●如果您的 PR 是对特定 issue 的修复，请在最后附上 Fix #id. 以下是一个例子：
fix(memblock/MMU): fix wrong decription of need_gpaThe previous document said that xxx, but actually xxxx.Fix #123.
●由于英文文档是通过 Weblate 平台（https://hosted.weblate.org/projects/openxiangshan/）翻译的，通常需要先在 Weblate 上修复，再同步到 Github。如果您不熟悉 Weblate 相关操作，建议您直接提交 Issue，由工作人员进行修复。
丰厚奖励等你来拿！
香山社区为本次活动准备了诚意满满的奖品，你的每一次贡献都将被认可！
● 最佳贡献奖（10名）：罗技 Lift 人体工学鼠标 + 毛德操老师《 RISC-V CPU 芯片设计：香山源代码剖析》书籍 + 香山环保袋 + 100积分。
● 优秀问题奖（15名）：50积分 + 户外便携野营音乐节水陆两用充气床+香山冰箱贴。
● 积极参与奖（30名）：10积分 + 手持头部按摩仪+香山贴纸。
● 特别奖励：PR 被合并到主干分支，额外获得 5 积分！
积分用途：香山培训兑换、礼品兑换、贡献排行榜排名。
分数计算方式！
● 每个有效 issue 可获得 1~3 分，由社区成员根据问题类型、质量等确定；若该 Issue 是该参与者的在当前仓库的第一个提交，将可能获得 Good Fisrt Issue 标签，并获得 2 倍的分数加成。
● 每个被合入主线的 PR 可获得 3~5 分，由社区成员根据贡献质量、重要程度等综合确定；如果该 PR 是参与者在当前仓库的第一个 PR，将获得 2 倍的分数加成。
● 个人总分计算说明：
○ 个人总分=个人提报的有效 Issue 分数 + 个人被合入主线的 PR 分数
社区支持
在活动过程中遇到任何问题，欢迎随时在 GitHub Issue 中提问，或关注香山社区官方渠道获取最新动态和支持信息。
期待你的加入，和我们一起守护香山文档，共建更美好的开源社区！