$HIW$              │
            ┼$HIY$◇$HIW$─────                         │
  ─────$HIY$◆$HIW$┼$HIG$        北大侠客行$HIY$帮助系统$HIW$       ┼$HIG$◆$HIW$──────
            │                         ─────$HIG$◇$HIW$┼
                                                 │

$HIR$                             文档编写说明$NOR$
———————————————————————————————————
    文档是指某种数据媒体和其中所记录的信息和数据，它具有永久性，并可以
由人或机器阅读，通常仅用于描述人工可读的东西。在软件工程中，文档常常用
来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书
面或图示的信息。
    文档是一项非常重要的工作，应当充分注意文档的编制和管理。文档的作用
在于：
    1.提高开发过程的能见度，把开发过程中发生的事件以可阅读的形式记录在
文档中，便于协调以后的开发、使用和维护。
    2.是开发进度和质量的检查依据，提高开发效率，并作为巫师在一定阶段的
工作成果和结束标志。
    3.提供对运行、维护和培训的有关信息，便于其他巫师之间的协作、交流和
了解，使后续开发活动更科学，更有成效。
    4.便于潜在玩家了解游戏的特点，吸引更多的玩家。
    从某种意义上来说，文档是开发规范的体现和指南。按规范要求生成一整套
文档的过程，就是按照软件开发规范完成一个软件开发的过程。

    在北侠，主要有下面几类用户文档：
    /doc/help中的帮助文件；
    /cmds，/kungfu/skill等文件中的int help函数；
    news和主页上的公告。
    作为巫师，应该对这几类文档的编写了解大致的规范。

帮助文件编写说明
    请参考本帮助文件的编写，包括彩色的「北大侠客行帮助系统」，底部的日
期、署名等。注意每行70个字符（35个汉字），每段有缩进。更新帮助文件后须
注意从help是否能找到本帮助文件，否则帮助也就没有太大存在的价值了。带边
框的帮助文件如果不能对齐，很可能用到了制表符\t，试试用Zmud的编辑器。

help函数编写说明
    这一函数的作用在于使用户不必翻help文件，只需help go即可取得命令go的
简要说明，或者verify yizhi-chan.?来查看一指禅的简介。注意在同一系列中尽
量保持格式相同。在精力允许的情况下，建议巫师尽量丰富这部分文档的内容。

news编写说明
    巫师可以用news -p 标题来发布新闻，注意！新闻是不能编辑的，即发布之
后尽管可以在mud中用news -d删除，但主页上的仍会显示，所以一定要想好了再
发，建议先用UltraEdit等软件打个草稿。每行最开始应留有至少一个空格，宽度
应以到第73个字节结束为准，再长则主页上会出现一行长一行短的情况，再短则
mud中不够美观。

$WHT$———————————————————————————————————$NOR$
