Wiki 书写规范

来自人生蓝图
(重定向自Wiki运营教程
跳到导航 跳到搜索


本文主要介绍,wiki文档的书写规范。

书写规则[编辑 | 编辑源代码]

  • 段首为一段话,对主题进行解释,形成一段摘要。
  • 多用标题,注意层级分明。多梳理条例,使用列表,和内部链接尽量有些条例。
  • 文章,优先使用文字,增加图片会影响操作者的体验。
  • 如果对3-5秒的等待时间可以忍受,则可以适当增加配图,图标优先流程图和思维导图。推荐走学术风格和插画可爱风格,排版尽量简洁。
  • 真正喜欢本站的人,推荐使用源代码进行编辑,建议学会wiki语法,享受编辑的过程。
  • 笔记协同,电子笔记和wiki结合,电子笔记为其收藏素材。wiki为输出,反复修改揣摩更改,否则会经常积灰。
  • 在协同方面,可以使用腾讯文档、飞书、语雀、石墨文档等软件。
  • 笔记一定要分好类,最好归档,整理。
  • 注意链接,相互联系。
  • 使用合适的插件,做好知识体系。

本站倡议[编辑 | 编辑源代码]

  • 对熟悉有感悟的知识,建立词条,在编写中学习,鼓励大家编辑。
  • 如果有数据分析类的,会编程语言,或者其他作图工具(PS、PPT)可视化最好。增加信息密度,让人们可以理解。
  • 当知识体量大的时候,很多作者已经记录的很全了。可以合理搬运,借鉴,摘录但一定要多加工和打磨。
  • 从外文搬运也很好,机器翻译和人工效验,也可以做做。提倡自发编辑,有能力的人记录,普通人在其中学习。
  • 希望大家可以自发形成手册,遵守操作规范。可以借鉴,其他站点的书写规则。
  • 帮助所有人,在文档中找到答案。可能我们是个开荒的团队,或者只是自己一个人搞搞事情。但尽量打磨,做出一个完整的开源共享产品。

相关文章:思考wiki Wiki作用 友链记录 编写源码 官方教程