Wiki文档工作规范
为了保证工作成员在创建、编辑、修改Wiki文档的时候不会遇到“撞车”事故,请所有成员都遵守此篇文档所规定的工作行为规范。
“撞车”事件
“撞车”事件(Crash)是指当多人同时编辑同一版本的Wiki文档时,提交所造成的提交版本冲突事件。此事件的结果据管理员yeni称,应当会造成多重版本的Wiki文档创建(根据提交时间),并且没有明显的提示。所以为了避免该事件的发生所造成的工作结果冲突,请遵守文档工作规范。
基准守则
最最最基本的一点,无论是修改一个错别字也好,还是修改一个链接也好,请先检查Active Tickets的Documentation类别( 此为所有类别为Documentation的活动的Tickets链接)中有没有人负责该篇文档。
如果有的话,可以:
- 给该负责人发Ticket要求该负责人修改文档
如果没有的话,可以:
- 给自己发Ticket修改该篇文档
创建新文档
创建新文档主要分为以下两个步骤:
- 准备创建文档(定义文档名)
- 撰写新文档并发布
准备创建新文档
当准备创建一篇新文档的时候,请给撰写者下Ticket。!Ticket的归类为Documentation,如需要请在详细说明中包含创建文档的名字。Wiki文档命名请遵守CamelCase法则。为了更好的分类整理,请在给Wiki起名的时候一定使用英文。如果是多篇同类文档,请在开头使用同一词汇,如:
[wiki:GameDesign/Roles 游戏角色设计] [wiki:GameDesign/Opening 游戏引子设计]
这样一来这两篇文档就会自动被分类到Game Design类里。
可以参考如下几篇文档:WikiNewPage,WikiPageNames,更具体的实例可以参考TitleIndex中各个文档的名字。
撰写新文档
当准备撰写新文档时,请一定要下单给撰写人。以便防止其他人创建、修改该文档。
建议:
- 编辑中多多利用Preview Page功能,查看文档格式信息是否正确
- 不要利用提交功能来进行格式的测试性查看,会添加更多无意义的Timeline以及Change Version
- 每10分钟提交一次,comment可以写上“间歇性提交保存”,以防止断网、服务器当机等造成的数据丢失事故
修改文档
如果该文档当前有确切的负责人,请主动联系该负责人(提交Ticket),申请文档内容的修改。修改后请在comment中注明最主要的信息变更说明。
代码
制作文档链接的时候,为了保持统一性和可读性,请将链接写为:
[wiki:DocumentName]
工作冲突协商
请以Ticket的形式协商争议性话题,严禁擅自随意更改文档核心内容。
总结
总而言之,所有的活动请以Tickets的形式提交注册。以防止撞车事件的发生。如出现工作冲突请与当事者协商。
另请参阅:#12撰写文档工作规范,撰写新文档,文档命名
