Wiki 撰写规范

Wiki文档的编辑必须使用网站编辑器撰写,不可复制其他网页内容且不清除格式,造成排版混乱;必须 遵循 中文文案排版规范;合理的通过标题、代码块和插图丰富文章的内容,因Wiki的编写通常需要参考较多的文档,也需要在文末列出参考来源。

为了避免歧义,本文使用了「能愿动词」,对应的解释如下:

  • 必须(Must) - 只能这样子做,请无条件遵循,没有别的选项;
  • 绝不(Must Not)- 严令禁止,在任何情况下都不能这样做;
  • 应该(Should) - 强烈建议这样做,但是不强求;
  • 不应该(Should Not) - 强烈建议不这样做,但是不强求;
  • 可以(May) - 选择性高一点,在这个文档内,此词语使用较少;

基础规范:

  • 必须 使用网站编辑器撰写,不可复制其他网页内容且不清除格式,造成排版混乱;
  • 必须 遵循 中文文案排版规范

1. 标题

规范:绝不 在 Wiki 文档的源代码中写入『一级标题』。

使用网站编辑器编写文档的目录结构,善用二级和三级标题,网站的文章模块会自动为您生成目录导航,这会让文章结构更加清晰,如下:

attachments-2019-10-ODiMpE225db8f024b3c0d.png

所有标题的含义要清晰,章节编号安按顺序编写,『操作步骤』类型的文章,都 必须 使用编号 来保证步骤清晰。

2. 代码块和插图

所有的嵌入的代码 应该 在样式中使用代码块,网站会将代码块的中代码自动高亮显示。

鼓励在文章中插入有明确示意的图片和gif动画,插入图片需要满足如下要求:

  • 应避免文件过大,为了保证加载速度,网站默认不支持3M以上图片
  • 图片插入的格式保持默认剧中
  • 图片备注的标题需要使用段落居中
  • 文章中插入的图片应明确无版权争议

3. 截屏

在涉及视图操作时,应该 合理利用截图来提高易读性。请多利用图片来表达和引导,如果能使用 Gif 动图就更好了。

  • 发表于 2019-10-30 10:28
  • 阅读 ( 64 )

[版权声明] :本文文字、代码及图片版权归原作者所有,任何媒体、网站或个人未经本网协议授权不得采集、整理、转载或以其他方式复制发表。已经本站协议授权的媒体、网站,在使用时必须注明“稿件来源:学研谷”。

0 条评论

请先 登录 后评论
猜猜我是谁
XY

133
提问
233
回答
53
文章
注册推广