====== 写作良习 ====== 优质维基页写作提示。 ===== 禁止行为 ===== **''绝对,不要使用中文做节点名称''** \\ {{:hoeron:good_style_pasted:20240506-085322.png?900}} 新建页面或者文件夹只能用数字、中划线、下划线、英文字符 {{:hoeron:good_style_pasted:20240506-085627.png}} ===== 维基页结构 ===== * 以简单明了的一级标题开始一个维基页; * 理顺页面的标题层次和顺序; * 用空行分段落,一个段落的文字控制在10到20行之间; * 如果一个主题内容论述多于3到5段,可以考虑将其[[:wiki:syntax#分级|分级]]为3到5个下级内容; * 当你的内容多于2到3屏时,在开始处的标题下要写一个摘要;当内容特别多时,可以考虑将其分成多个页面; * 当页面有很多链接需要其他维基页和外部资源的时候,可以考虑添加一个参考文献部分(例如 [[#参考文献|下面]])。 * 如果大部分页面都属于一个[[doku>namespaces|命名空间]]时可以考虑共享一个[[doku>namespace_template|命名空间模板]],这样新页面就可以直接从该模板生成了 * 避免使用过于复杂的命名空间结构,尽量使用简短易记的命名空间 * 维基用户考虑利用[[doku>plugin:qc|质量检验插件]]来检查页面机构和语法格式。 ===== 文本格式 ===== * 重点词或者段落使用**粗体**或者//斜体//。选择一种并坚持使用(中文重点只选择粗体)。 * 坚持使用通过按钮或者菜单方式选择一种带有格式的屏幕文本输出。对于格式输出要附有说明。 * 对于关联性不强的几点使用[[:wiki:syntax#列表|无序列表]],如果你在描述一个思考过程,那么就要使用一个连续的相互联系的过程来描写。 * 慎用[[:wiki:syntax#脚注|脚注]],仅限简短说明。对于需要大篇幅说明的注释可以单独开一个维基页面。如果想要将说明指向外部信息源,使用[[:wiki:syntax#链接|链接]]即可。 * 表格可大幅度提高数据的可读性和结构性。使用表格要确保有意义明确的表头和表述清晰的表名。(例如. "表格 1.2: 行星间平均距离")。 * 大表不易修改。可以考虑使用嵌套的列表。 ===== 语言 ===== * 行文时使用恰当的语句,必要时使用名词。 * 句子开始使用大写字母((中文不适用)),结束使用句号或者其他标点。 * 多用简洁明了的短句,少用复杂的从句。内容完成后,要重新阅读并修改不恰当的地方。 * 确定读者定位。DokuWiki 适用于写文档,所以需要引导读者阅读。您可以使用//祈使句//形式(“//干//就完了!”),//我们/你们//格式(“然后//我们/你//点击……”)或者//我//格式(“//我//然后吃饭……”)。切忌不要混淆称谓。 * 发布前检查语法或者拼写错误。如果您的内容出现错误,不管内容多牛都会降低可信度。 * 养成自己的写作风格。不要强迫自己使用不喜欢和不擅长的风格,否则可能会导致不伦不类。 ===== 参考文献 ===== * 当遇到需要大量文字解释说明的术语时使用新的维基页面并做好链接。 * 完成页面撰写后再检查一遍,对于已有维基页面的术语添加相关链接。 * 不必每次都为出现的特定术语做链接。只为那些第一次或者经常出现的术语添加链接或者参考。 * 为图像、数据和引用的出处提供链接。 * 在页面结尾添加"参见:"行。提供与页面主题//密切相关//的维基页面的链接。 * 如果想提供有关主题或有益于编写页面的外部资源,请在文末添加一个名为“参考”或“延伸阅读”的部分,并提供相关资源链接或清单(例如ISBN号)。 如果没有这么做,请说明原因。 * 配置[[:interwiki|维基间链接]]快捷方式可以帮助快速链接到共同资源。 ===== 图像和其他多媒体 ===== * “一图胜万言”,甚至//超乎您想像//。((那么,您能用一张图替代这个引用吗?)) 人们往往对图像的真实性的质疑要比对语言的真实性的质疑少。简短的文字说明比不准确的图片更好。 * 如同表格一样,图像也可以添加标题,来说明图像的使用意图。 * 如果不是原创,请注明出处(可使用链接)和版权声明。 * 除非明确允许,否则不要链接外部站点图像。首先是因为版权问题,其次是因为盗用带宽流量而将[[config:fetchsize|缓存外部图像]]关闭问题。 * 如果图像大于屏幕的三分之一,使用[[:wiki:syntax#多媒体文件|链接重置大小说明]]来插入一个缩略图。