必经之路

抄一部心经,点一盏心灯

用户工具

站点工具


wiki:xiewendang

**这是本文档旧的修订版!**

如何用 wiki 写一份专业的文档

作者:蓝狮子
版本:V0.1.0
时间:2025.4.24
说明:看这篇文章之前,你需要了解基本的 wiki 的语法,懂得基本 wiki 操作


wiki 很强大,有自己都有的风格。与word 上写文档相比,wiki 有一些自有的优势,如:存在线上,方便他人查看和更新,有历史备份记录等。Wiki 还有一个优点:文档可以自己生长。当你想写一份专业的文档,但没有想清楚,可以先开始,然后一点点想法更新、添加内容,这是蓝狮子常用的方式。

本文就介绍这种,如何用 wiki 写一份专业的文档。主要是介绍蓝狮子自己写 wiki 文档的经验。

一、技巧提示

蓝狮子用 wiki 写文档常用的一些排版技巧:

  1. 吸引人的文档标题。文档标题很重要,一个好标题吸引大家点击查看,也可以让读者了解文档的主题,还方便大家用搜索功能,搜索到相关的文档。
  2. 简洁的小标题。wiki 会根据小标题会自动生成目录。所以小标题,最好有序号,整个长度不超过 7个汉字。这样文档目录会很整齐。
  3. 版本更新记录。有版本号,和版本更新记录。这一点【非必须】,主要是为了方便大家查看更新记录。本文最后有【版本号说明】
  4. 使用额外颜色。文字颜色非常有助于读者抓住重点。蓝狮子一般用最简单的<color blue> 蓝色</color> 蓝色
  5. 相关文档链接。可以在文档中增加相关文档链接,可以返回主页,可以是其他类似说明文档链接,这样方便大家直接从这个文档查看。

其他技巧:

  1. 自然增长。如果没有想好文档整体该如何写,也可以先开始,然后每天增加一点。这点很有意思的,你可以试试。若更新内容较多,可以升级版本号,写版本更新记录。

相关链接

版本更新

  1. V0.1.0 2025.4.24开始写草案。

【版本号说明】1)

  • 如果文档还在完善过程中,没有正式对外发布,以 V 0.x.x 来标志。如:V0.1.0 正式文档,对外发布,就用 V1.0.0
  • 如果是文档的小更新,如修正了某些错字,添加了几处说明,或做了某些小的修改。就 修改小版本好。如:从V0.1.0 到 V0.1.1
  • 如果是文档稍大一些的更新,如更改了框架,某部分增加了比较多的内容,就更改中间的版本号。如:从 V0.1.0 到 V0.2.0
  • 为了方便自己记忆,也方便他人查看,可以在文档末尾,增加版本更新信息。就是每一次版本升级时的时间,版本号,和更新的大体内容
1)
蓝狮子平时使用的方式
wiki/xiewendang.1745496569.txt.gz · 最后更改: 2025/04/24 20:09 由 lanshizi