保持良好wiki写作风格的建议
以下是一些关于如何撰写一个优质维基页面的建议
页面结构
- 用一个一级标题开始你的页面, 起一个意义明了题目
- 按正确顺序嵌套标题级别. 第二级的内容应该以一个二级标题开始
- 段落之间用空行隔开. 平均而言, 一个段落不应该长于10-20行
- 如果你的内容长于3-5段, 考虑用二级到五级的标题把它分成几个章节
- 当你的内容长于2-3个屏幕页时, 在这个页面的第一个标题下放一个简短的摘要. 当你的内容特别长的时候, 考虑把它分成多个维基页
- 如果你有很多到其它维基页或者到外部资源的链接, 应该添加一个“参考”的章节
- 如果同一个命名空间(内部链接)下的很多页面都有一个相同的页面结构, 添加一个这个命名空间的模板, 这样任何新的页面都能用这个框架开始撰写
- 尽量避免过于复杂的命名空间结构. 尽量使用简短、好记的空间命名
文字格式
- 用粗体或者斜体强调单个词语或者较短的文字段. 二者选一, 不要换来换去交替使用
- 该句尚未翻译
- 对于相互独立的叙述使用无序列表(unordered list). 如果你在描述一个思维过程, 应该把它们写成一个由语句构成的连续的文字段
- 表格可以极大的提升结构化数据的可读性. 如果你插入了一个表格, 确保它有意义明确的单元格名称和一个能清晰描述表格内容的标题(例如, “表格1.2: 行星间的平均距离”)
- 大的表格会很不好修改. 考虑用嵌套列表来表示
语言
- 书写没有语病的句子, 并且在必要的时候为名词添加冠词
- 以大写字母开始句子, 并且以句号或者其它合适的标点结束
- 尽量书写简短、清晰的句子, 不要使用太多的从句. 当你觉得写完一个维基页面的时候, 从头再读一遍并且修改那些结构过于复杂的句子
- 判断如何称呼你的读者. 由于DokuWiki主要用于书写文档, 你会经常需要指导你的读者如何去做某些事情. 你可以使用命令形式(“这样做!”), 我们/你形式(“然后, 我们/你点击…”), 或者我的形式(“然后我用…, 将foo添加到栏位”). 不要混合使用这些形式
- 在保存之前检查你页面的语法或者拼写错误. 如果你的文字有很多错误的话, 将会降低你的叙述的可信度, 而不论它们有多牛逼
- 发展你自己的写作风格. 不要强制你自己用自己不习惯的风格写作. 这样只会听起来不自然, 读起来也不舒服
参考
- 当你有一个需要更多解释的术语时, 给这个术语添加一个新的维基页面, 并且链接它
- 在完成之前重新检查, 给你的页面中的关键术语添加到已有维基页面的链接
- 不要在某个术语每个出现的地方都添加链接. 在第一次或者最现著的出现位置添加链接, 可能还有在“参考”这一章节添加一个链接
- 添加到图片来源、数据来源、引用来源的链接
- 考虑在你的页面结尾添加一行“另见:”(See alse). 提供一些和你当前页面题目关系密切的维基页面的链接
