修订指南
注 (@tiankaima):在 2024.09, 我对 https://lug.ustc.edu.cn/wiki 页面下的大量内容做了修订,以下是修订时所参考的一些原则,以及希望后续编辑能够思考的一些问题。
-
提供信息的考虑:简洁、有效的导航
应当说,大部分来到 lug.ustc.edu.cn 的同学都是带着目的的,无论是想了解
- LUG 作为一个社团的开展情况 (举办的活动、怎么加入)
- LUG 提供的服务 (都有哪些,怎么使用)
- 联系方式 (咨询、报告问题) 等
这个 wiki 应该为他们提供最方便、最简洁的信息。基于这个原因,我调整了:
-
自我审查方面的考虑
-
信息一致性
在修订时,有很多内容仍然存在「BBS」、「邮件列表」等不再密集使用的平台信息,调整后,上述联系方式都以链接的形式统一指向 联系我们 这唯一的页面。
出于备份的考虑,News 下的页面均未更新这些内容,但是将邮件地址调整为图片 (仅官方邮件地址)。
此外 wiki 首页 有一个简短的介绍,如需更新也请注意
此外,删掉了 英文介绍页面, 这倒并不是出于政治或者审查原因,而只是一致性 & 翻译软件的成熟度的考虑。
-
Beginner Friendly
修订时,尽量避免了「名词门槛」的问题,例如 GitLab 页面中使用「代码托管平台 GitLab」的表述,而不省略成 GitLab, 即使 LUG 的成员对这个名字已经足够熟悉。
其他类似的修订包括:「网络启动平台 PXE」、「文件存档 FTP」、「信息安全大赛 Hackergame」、「软件自由日 Software Freedom Day」等。
如果可能的话也保持这样的 中 + 英的表述 (和顺序), 在需要省略的地方也省略 (例如导航栏) 英文而不是中文。
-
排版美观
例如在这个页面中,每个子项标题加粗,同时提示内容使用
{: .notice--info}
标签,使得页面更易读。同时在链接前后保留空格。
关于 Markdown 站内链接的使用
目前 Jekyll 的配置支持使用「直接指向
.md
文件链接 (相对目录)」的写法,但是并未全站采用这样的做法,理由如下:
目录与文件名重名的问题,例如之前
_wiki/
目录下同时存在./scripts.md
和./scripts/
。现将./scripts.md
调整到./scripts/index.md
,并在其中配置permalink: /wiki/scripts/
以保持原有链接的有效性。
在这个例子中,书写
../../_wiki/scripts/index.md
显然不如书写/wiki/scripts/
来的简洁,因此没有调整。建议所有站内链接以
/
结尾,以保持一致性。本次调整中未更新已经完全失效的链接
将所有
lug.ustc.edu.cn
的站内链接全部调整为/
挽救了部分 FTP 目录迁移的链接
在 News 页面下使用了
.md
的写法,例如 这篇文章 直接引用同目录文件2021-04-27-lug-banshan.md
;我们也推荐 News 下所有目录采用这样的写法。