内容书写指导

内容书写指导 #

考虑到仓库内容体量和创作者之间写作习惯的差异,因此认为有必要指定一个仓库的内容书写指导以提供风格标准。

内容组织结构 #

主题 / 系列 #

以一个顶级文件夹作为主题或者系列,围绕主题组织 Markdown 笔记。

例如「资源合集」作为一个主题,下面具体组织形式由主题发起者规定。其余人在添加时请默认保持主题。

主题的发起者如有可能,尽量为主题书写 _index.md 为主题进行定调介绍。

请保持主题下笔记具有相似性。

如果主题下的笔记少余 3 篇,则会被移动至「大杂烩」主题。

合并主题 #

仅有仓库管理员才可合并主题(即合并多个顶级文件夹)

管理员需要辅助的事情 #

在批准添加内容时浏览内容,并在同意后根据情况进行以下操作:

  • 如果有新主题

    • 先在新主题下进行评论,创建评论页面。

    • 再在具体页面下评论,创建评论页面。

这么做是因为评论系统的特性,会匹配相近 url 来匹配评论区,如果在子页面评论创建了讨论,会把上一级页面的评论区锁定上去,并且无法创建。

内容书写标准 #

内容标准 #

写作不应该被框架束缚,但遵循某些原则能极大地提高阅读体验,以下是对于改善文章内容相关的 建议

如果可以,请尽量遵守如下规则:

  • 尽量不要提交未完成内容,除非你是该主题主要贡献者。

  • 在文章开篇,写出文章适用人群或者文章概括、看前须知。

  • 在书写内容时,尽量遵循「总-分」等合理的文章结构。如果不知道用什么结构,则请遵循「在提出长篇大论前,先在上方写出概括性论述」。

格式标准 #

同样的,请尽量遵守以下格式,以提供统一的文本风格。

  • 中英文切换的地方用空格隔开,例如 write some text in english here. 这样。同时中文用全角(中文符号),英文用半角(英文符号)。

  • 中文英文数字公式之间要以半角空格隔开,行内 $\LaTeX$ 公式两侧必须包裹有空格行外 $\LaTeX$ 公式两侧必须包裹有换行

  • 加粗内容用于警示、重点,请不要随意滥用加粗内容。(读者不想看再怎么加粗也没用)

  • 斜体用于可忽略的、吐槽性质、篇外话、可选的或不太重要的内容。

  • 斜体+粗体适用于可选且重要的情况,例如 「Git 使用 ssh 配置的话,则使用另一套步骤」这样。

  • 尽量不要随意使用删除线。

  • 根据大纲使用标题,而不是想要 字大点

  • 内联代码格式用于代码块,或者可执行的语句。

  • print("善用代码块")
    
  • 引用用于引用,或者备注、提示、警告

  • 少用分割线,多用标题分离内容。将分割线用于非常离题并且很长的内容,放在文章末尾。

Git 规范 #

在对文本内容进行修改时,尽量使用“标题:Commit 内容“进行修改。

例如:大杂烩:添加了 5 条各种资源的链接