软件的文档到底怎么写？(100分)

找本软件工程的书来看吧！书中自有黄金屋，书中自有什么玉！

书=死板的教条
实例=前辈的经验总结
实在不行就算了，我再等一天，晚上还没有结果就结束...

抄一份吧，不是我写的。
***************************************************************
*********************
需 求 分 析
一 目标：
本系统的任务是在科研室这一特定环境中，实现无纸办公:具体的功能有项目管理
，系统内部的讨论区，
邮件系统与日志管理。
二 功能划分
1．公共信息
讨论区
公告栏
图书借阅
会议管理
2。个人信息
工作日志
个人日程安排
3．邮件系统
通讯录
邮件
4．项目管理
审批
项目过程管理
文档库
三 功能描述
1．公共信息
1．1 讨论区
一个科研室内可以用此来共享思想与讨论问题。
1. 阅读讨论区的内容
用户可通过三种视图查看讨论区中的文章：
a. 所有文档视图按时间顺序显示了全部的讨论主题和它们的答复文档。
b.作者视图清楚地罗列出了曾经撰写过文章的作者姓名。
c.分类视图给出了讨论所属的分类信息。
您可以按照自己的需要选择相应的视图浏览信息。
2. 参加讨论
选择创建主文档，这样您就开始了一个新的讨论主题。（讨论主题可从曾在的系统中选择，或自己创立）
3． 答复一个文档。
4. 将文档标记为私人
您可以使用“标记私人”或“标记公共”操作来控制别人是否能够阅读您的文档。例如，
如果您还没有完成一个特定的文档您就可以使用这个功能。首先将此文档标记为”私人“，这样其他人就看
不到这个文档。在您全部完成这个文档之后，您可以将它标记为“公共”。
5． 将文档标记为过期
使用操作菜单中的菜单项“标记文档过期”。过些日子(具体时间由归档简要表指定）这些过期的
文档将被拷贝到归档数据库中并且从原来的数据库中删除。
6．设置个人兴趣简要表
讨论区的内容可按个人兴趣显示，你可以选择是否通过发送新闻简
报来通知您讨论库中已经出现了其中一些你感兴趣的东西。
1．2 公告栏
以广播形式公布公告，通知或启事。
a. 通知
个人通知: 针对某个人发出。
群体通知
b. 公告
c. 启示
1．3 图书借阅
进行教研室公共资料的管理
a. 登记教研室公共资料
b. 记录图书的借阅信息
1．4 会议管理
对会议进行管理
1． 会议安排
a. 会议组织者做会议安排，以广播的形式将信息发送给会议参加者
b. 会议参加者收到信息，做出答复
2． 会议流程
3. 会议纪要
2 。 个人信息
2．1日程安排
1． 备忘录
显示日历与每天的待办事宜。
2． 日程安排
a. 内容：约会
邀请
事件
提示
纪念日
b. 服务
☆ 闹钟：到特定时间自动宣示提示内容
☆ 邀请函
1． 发邀请函
2． 答复
2．2 工作日志
1． 在系统提供的表单中填写日志。填写后的文档，可从工作日志视图中看到，文档以时间排序。
2．日志的管理
对于项目管理者，所有日志文档都是可见的与可写的，他具有以下
权限：
a.可对所有文档进行归类。
b.点击某一文档时可看到具体内容，可进行批示，系统将提醒
作者查看。
3． 邮件系统
3．1通讯录
a. 公共通讯录
1．在服务器中注册的个人都会在此显示, 用以系统内通信.
2．系统管理可以添加用户，添加结束后，新用户信息将再此显示
b. 个人通讯录：
用户可以组织自己通讯录，以显示自己感兴趣的用户的信息。
3．2邮件
1．基本邮件
系统提供三个简单的表单来创建一个新的邮件消息:
便笺 - 使用本表单来创建一个新消息。
回信 - 使用本表单来答复一个您所接收到的消息。本表单仅在您选择了一个文档来答复时使用。
回信(附带原文) - 类似于一个答复，只是将要答复消息的一个拷贝自动
附加到您的新消息中。
2．特殊邮件
a. 转发邮件
你可将你收到的邮件转发给一个或多个人。
b.传阅邮件
你可将邮件发送给多个收件人，每个收件人都可以在邮件中添加
自己的意见并将消息发送给下一个人，如果有一个人不同意邮件中的提案，他可以不
发送给下一个人，从而中断传阅的流程。
c.书签信息
向别人推荐某个文档，作用与“转发邮件”相似，但你发给别人
的不是原文，而是一个指向文档的链接。
d.外出自动答复邮件
在你外出期间，notes自动答复你收到的邮件。（内容由你设定）。
4． 项目管理
4．1审批
使用系统的审批系统，向上级提交申请，有两种提交方式：
a. 传递
审批提交人将待审批文档发送给多个收件人，每个收件人都可以在邮件中添加自己的意
见并将消息发送给下一个人，如果有一个人不同意申请中的提案，他可以不发送给下一
个人，从而中断传阅的流程。
传递结束后，文档发回给提交人，系统将提醒提交人查看。
b. 一起传送
审批提交人将待审批文档同时发送给多个收件人，每个收件人都可以在邮件中添加
自己的意见并将消息发回。
4．2项目过程管理
1． 进行项目登记
由项目管理者填写项目登记表。
2． 分配任务
使用这个表单来提醒你所要做的事，或告诉其他成员要为您做的
事情。如果您将一个“任务”发送给一个或多个其他的邮件用户，他们
将能够通知你何时完成该任务。
3．进度管理
在需求分析，概要设计，详细设计，编写代码，测试等阶段项目管理者对开发进度进
行控制：
a. 技术文档的审批
在各开发阶段，开发人员向项目管理者提交技术报告，项目管理
者进行审批，只有当项目管理者同意后，开发人员才能进行到下一阶段
b. 讨论问题
项目开发人员就开发过程中的问题向项目管理者或同组人员提问，被问者给以解答.
4．结束登记
5．版本控制
当一个用户修改了一个公共数据库中的文档后，系统会将其另存为新的文档，
即原文档的新版本，从而实现多用户的协同工作。
4．3文档库
进行项目开发过程中技术文档的控制
? 技术文档
本系统提供需求分析，概要设计，详细设计，测试报告等与项目有关
的重要技术文档。
? 发文文档
科研室发送出的文档
? 收文文档
科研室收到的文档
? 会议记要
记录会议记要

好的，谢谢doxpix，此问题结束后我将给您另开一个200分的题。
8小时倒计时...

与其说软件文档难写，不如说软件设计难说。
一般教材能给的实际指导作用，在我看来相当有限，
看得时候，也许觉得头头是道，但实践应用总觉得有点
隔靴搔痒。而的UML方面的书中的例子一般也比较简单，
也不太容易有感觉。最好的办法，还是有比较有OOD设计
经验的人带一个项目，这样才会有切身感觉。
个人以为用usecase图，进行多user角度分析系统功能，
对模块功能相对分离挺有好处，能比较好避免讲多个层面
多个角度的问题搅在一起考虑。是进步细化的重要基础。
我认为，一个分析的过程要远比一个分析的结果总要的多。
毕竟知道目的地在哪里和如何达到目的地，在很大程度上是
完全不同的两码事情。

listen

doxpix：
请到http://www.delphibbs.com/delphibbs/DispQ.asp?LID=494012拿分，谢谢

多人接受答案了，谢谢各位

多人接受答案了。

碰上你这样的主儿，真是大呼爽快！