myhan@CNBLOGS

To be, or not to be: that is the question ...

导航

软件的文档

一个标准的GNU软件应该有的文档,一般来说软件的源代码目录下面应该有下列文件:
README      使用者首先阅读的文件,一般是软件的简介。
INSTALL     配置、创建与安装指南。
CREDITS     贡献者的列表。
NEWS        开发新闻。
HISTORY     软件的历史。
COPYING/LICENSE   软件版权(一般当然是 GPL)。
MANIFEST    每个文件作用的介绍。
FAQ         常见问题解答(FAQ)文档。
ChangeLog   各个版本之间的变化历史。
TODO        计划中要做的工作。
以上文件的格式都为文本文件,除了ChangeLog需要在每次改动的记录之前标注时间,TODO的各项工作用*号开头以外没有特别的要求,当然美观大方的排版是必须的。

posted on 2004-07-01 18:09  梦函  阅读(363)  评论(0编辑  收藏  举报