跳转至

读者须知

使用说明

文档就是文档

如何使用这一份文档,其实没有那么多条条框框。

文档维护者、编写者会尽力保证每一篇文档具有完整的逻辑链条,尽力保证读者可以做到从头到尾通读。所以如果您是某个领域、框架、语言的初学者,可以尝试着从文档的最开头开始,跟随着文档的逻辑学习。

每篇文档都会有前置知识部分(位于体量较小的文档的开头或者体量较大的文档的 Index 页面),我们希望您在通读文档之前,先确认自己已经掌握了这一部分要求的前置知识。

每篇文档还会有后续拓展或者资源链接部分(位于体量较小的文档的末尾或者体量较大的文档的 Index 页面),我们希望您在通读文档之后,根据自己的知识需求继续学习这些部分给出来的资料。


您也可以将该文档作为工具书,在需要的时候根据目录查询想要了解的知识。

课程指引与资源链接

如果您是由于课程要求需要学习新的语言、框架等等,可以先进入课程指引部分,根据课程名查找可以参考的文档列表。

资源链接部分则列举出了可供大家课外学习的一些网站和书目。

如何向我们反馈

本文档依然是一份还不成熟的文档,内容可能还不完备,一些功能可能也并没有那么稳定。所以,如果您在阅读中遇到了问题,无论是链接失效、页面缺失这些功能问题,还是文不对题、讲解模糊、内容矛盾这些内容问题,都可以向我们提出,我们会尽快答复。另外,所有的改进意见、修改建议也都可以向我们提出。

目前我们接受反馈的方式为 GitHub Issue,为此,您需要注册一个 GitHub 账号。

需要反馈时,点击页面右上方的“SAST skill docs”进入我们的 GitHub Repo,点击 Issue 栏目后点击右侧的 New issue 按钮,在输入框内输入您想要反馈的问题或者意见建议后,点击 Submit new issue 即可。

  • 如果您想要反馈功能问题,我们希望您能够在 Issue 中说明该问题的具体表现、如何复现这一功能问题以及该问题是否可以稳定出现。

  • 如果您想要反馈内容问题,我们希望您能够说明是哪一篇文档的哪一段落的内容不适当,如果能够提出修改意见则更好。我们会尽快和这篇文档的主编写者讨论修改。

  • 如果您想要反馈改进意见,我们希望您能够说明如何改进以及这样改进能带来的好处。

  • 如果上述反馈类型均不符合,只需要将您想要反馈的内容写明白即可。

我们希望通过编写者、读者、维护者的共同努力,打造好这一份技能引导文档,将大家的经验和知识传递下去,为打造 user-friendly 的计算机系而努力。


最后更新: 2022年1月17日
作者: Ashitemaru (85.37%), c7w (14.63%)