Wiki 维护规范
一、维护目标
协会 Wiki 用于沉淀协会知识资产,包括组织介绍、学习路线、技术教程、项目文档、竞赛资料和活动归档。
维护 Wiki 的目标是:
- 让新人更容易入门;
- 让经验可以传承;
- 让项目可以复用;
- 让活动可以追溯;
- 让协会发展有记录。
二、命名规范
文件名应简洁清晰,例如:
1 | C语言学习路线.md |
不建议使用:
1 | 新建文档1.md |
三、内容规范
一篇文档建议包含标题、背景、正文、示例、注意事项、参考资料和更新时间。
四、更新规范
- 不删除仍有价值的历史内容;
- 技术教程应尽量验证可用;
- 链接失效应及时替换;
- 过时内容应标注;
- 重要修改应记录更新说明。