GUIDE.md

文档校对指南

前提

本站的所有文档都是使用 Markdown 格式编写的，所以你需要对 Markdown 有一定的了解（不了解其实也没关系，因为所有文档已经带了格式），这里有一份 Markdown 语法指南：Markdown Guide。

文档校对

你首先需要一个 Docs4dev 的账号（可以直接使用 Github 登录），登录网站后选择你要校对的文档的具体章节，然后点击编辑此页按钮进行校对。如下图所示：

注： 目前只支持对文档的中文版本进行校对，所以如果你浏览的文档是英文的话，是不会出现校对按钮的。

开始校对

文档校对页面如下所示：

文档校对页面包含了两部分，左侧是 Markdown 编辑器，用于修改文档，而右侧则是文档对应的英文原文，方便进行对比。

完成校对

当你完成文档的校对后，可以点击右上角的保存按钮提交文档至后台审核，如果你只是想暂时保存用以下次修改，你也可以将文档加入草稿箱。如下图所示：

文档差异对比

当你选择保存到草稿箱或是提交审核后，你还可以从结果弹窗选择 查看修改项 （或是 文档校对 列表中点击Diff）按钮，进行文档对比查看修改点。

文档审核状态

当你校对完成并提交后，我会对修改项进行简单的审核，如果没有大问题，将会直接合并到线上版本。文档合并（或退回）后，会有站内通知提醒，同时，你也可以在 我的主页/文档管理/文档编辑 列表查看校对结果。

校对内容建议

对于校对文档的内容，有以下几点建议：

1. 最好不要修改文档本身的 Markdown 样式，除非样式本身有误。如：加粗，代码，链接样式，标题的属性等等。
2. 对于某些样式，如果你觉得需要修改，可以参考：文档写作指南
3. 在翻译时，对于专有术语，最好不要翻译，而直接使用英文，如：Spring Boot, Ant, Maven 等。
4. 如果文档原文本身有误，请提 Issue 给我。
5. 如果你在校对的过程中发现了其它的问题，也请告知我。

注：

1. 如果你在校对的过程中遇到了某些空的 a 标签，如: [{#background-ioc}]()，请 不要删除 它，因为它是用于产生 anchor 标记来定位页面的。

2. 如果你发现在 head 标签中，有一些类似于 {#abc} 这样的字符，请 不要删除 它，它也是用于产生 anchor 的。如以下的 h2 标签：

## {#overview-dependency-injection} 2.1 依赖注入和控制反转

3. 同一篇文档同一个用户可以反复校对，所以对同一篇文档，可以分多次进行校对，校对次数没有限制。

其它

如果你觉得这个文档有什么需要改进的地方，请提 Issue，当然，也欢迎直接提 PR。