GigaHttpd 开发文档写作规范


版本:    0.1
提交时间: 2008-04-02
本版作者: 鲁义明 （Yiming Lu） lu.yiming.lu@gmail.com
所属:    GigaHttpd 开发文档



* 说明

    本规范每一项都先注明是否必须遵守。


* 语言

    本项必须遵守。

    编写开发文档所用的语言，如下：

    (1) 简体中文，必须。

    (2) 英文，可选。


* 文档版本信息

    本项必须遵守。

    格式如下:

      版本:    n.n
      提交时间: yyyy-mm-dd
      本版作者: 中文名字 （英文名字或中文名字的拼音） 作者的 email 地址
      所属:    GigaHttpd 开发文档/介绍文档/用户帮助文档

    例子:

      版本:    0.1
      提交时间: 2008-04-02
      本版作者: 鲁义明 （Yiming Lu） lu.yiming.lu@gmail.com
      所属:    GigaHttpd 开发文档


* 章节编号

    本项必须遵守。

    文档的章节标题前用星号 * 数量来表示。最高的章节用一个星号 *，其余类推。禁止在文档中采用章节数字顺序编号，如1，2，3...，或者一、二、三...

    文档的章节标题前不能有空格，即不缩进。

    此项规定的原因主要有两个：

    (1) 便于 diff 文档版本之间的差别。

    (2) 方便于用 emacs 大纲模式查看文档。

    GigaHttpd 团队会开发转换工具，可以把文档中的章节添加上数字编号，用于其他方式浏览或出版。


* 空格与 Tab

    本项必须遵守。

    空格全部用英文半角空格。

    在中文文字间插入英文单词、数字时，应在前后添加空格。

    禁止用中文全角空格，文本作图出外。

    禁止用 Tab。需要用 Tab 的地方全部用空格。


* 标点符号

    本项必须遵守。


* 段落与空行

    本项必须遵守。

    段前留 4 个空格，用作缩进。

    没有行宽限制。不可以人为设定行宽，手动增加回车。

    段落于段落之间以空行间隔。

    章节（无论大小）结束后，增加一个空行，以增加阅读美感。


* 推荐的文档阅读器

    本项不要求必须遵守。

    推荐用 emacs 来阅读文档，主要是利用 emacs 的大纲模式，阅读起来比较方便。