[转]软件开发规范—模块开发卷宗(GB8567——88)

做软件开发是有那么一套国准可参照的，当然就是那些文档了，这里列出一下所有软件开发的规范文档：

• 操作手册
• 用户手册
• 软件质量保证计划
• 软件需求说明书
• 概要设计说明书
• 开发进度月报
• 测试计划文档
• 测试分析报告
• 数据库设计说明书
• 软件配置管理计划
• 模块开发卷宗
• 详细设计说明书
• 项目开发总结报告

我现在再做的东西是数据库设计说明书，两天前才写玩模块开发卷宗，那时候在网上找了一些事例不是很符合规范，而完全对着模块开发卷宗的模板去写真不知道里面要写什么，因为里面有太多概念性的东西都看不懂，在这里贴以下广佛都市网的模块开发卷宗，仅供参考。

广佛都市网

模块开发卷宗（GB8567——88）

2009年8月

广佛都市网模块开发卷宗（GB8567——88）.................................................................... 1

1.    标题.......................................................................................................................... 3

软件系统名称：广佛都市网....................................................................................... 3

模块名称................................................................................................................... 3

内容发布管理系统.............................................................................................. 3

内容支持平台..................................................................................................... 4

通行证管理系统................................................................................................. 4

博客管理系统..................................................................................................... 4

分类信息系统..................................................................................................... 4

论坛系统............................................................................................................ 4

程序编制员签名........................................................................................................ 4

修改完成日期: 2009年8月3日................................................................................. 5

2.    模块开发情况表........................................................................................................ 5

3.    功能说明................................................................................................................... 7

内容支持平台(http://sys.citygf.com)............................................................................ 7

用户管理模块..................................................................................................... 7

博客管理模块..................................................................................................... 7

圈子管理模块..................................................................................................... 8

广告管理模块..................................................................................................... 9

论坛版块管理模块............................................................................................ 10

分类信息管理模块............................................................................................ 10

流量统计模块................................................................................................... 11

系统设置模块................................................................................................... 11

投稿、举报、辩论其他模块.............................................................................. 12

通行证管理系统(http://public.citygf.com)................................................................... 13

个人信息管理模块............................................................................................ 13

好友模块.......................................................................................................... 13

站内短信模块................................................................................................... 13

分类信息模块................................................................................................... 13

稿件管理模块................................................................................................... 14

安全设置.......................................................................................................... 14

博客管理系统(http://blog.citygf.com)......................................................................... 14

日志模块.......................................................................................................... 14

相册模块.......................................................................................................... 15

留言管理模块................................................................................................... 15

博客模板、风格设置模块................................................................................. 15

圈子活动管理................................................................................................... 16

圈子模块(http://group.citygf.com)...................................................................... 16

活动模块.......................................................................................................... 16

分类信息系统(http://fenlei.citygf.com)....................................................................... 17

分类信息发布................................................................................................... 17

按大小分类、区域进行浏览.............................................................................. 17

显示热门、推荐信息........................................................................................ 17

4.    设计说明................................................................................................................. 17

内容发布管理系统................................................................................................... 17

内容支持平台.......................................................................................................... 17

博文排行.......................................................................................................... 18

博客之星.......................................................................................................... 18

最新博文.......................................................................................................... 18

点击排行.......................................................................................................... 18

推荐圈子.......................................................................................................... 18

相册................................................................................................................. 18

推荐博客.......................................................................................................... 18

最近开博.......................................................................................................... 18

用户登录.......................................................................................................... 18

通行证管理系统...................................................................................................... 18

博客模块................................................................................................................. 19

分类信息系统.......................................................................................................... 19

论坛模块................................................................................................................. 19

5.    原代码清单............................................................................................................. 20

解决方案PORTAL................................................................................................... 20

PORTAL........................................................................................................... 20

PORTAL_DL..................................................................................................... 20

PORTAL_W...................................................................................................... 20

Studio............................................................................................................... 20

解决方案BLOG....................................................................................................... 21

BLOG_DL......................................................................................................... 21

Studio............................................................................................................... 21

BLOG............................................................................................................... 21

BLOG_W.......................................................................................................... 21

GROUP............................................................................................................ 22

GROUP_W....................................................................................................... 22

INFO................................................................................................................ 22

INFO_W........................................................................................................... 23

PUBLIC............................................................................................................ 23

PUBLIC_W....................................................................................................... 23

6.    测试说明................................................................................................................. 23

7.    复审的结论............................................................................................................. 23

1.   标题

软件系统名称：广佛都市网

模块名称

内容发布管理系统

采用北京拓尔思信息技术股份有限公司的“TRS内容协作平台”软件V6.0,详情请参见TRS内容管理系统

内容支持平台

用户管理模块

博客管理模块

圈子管理模块

广告管理模块

论坛版块管理模块

分类信息管理模块

流量统计模块

系统设置模块

投稿、举报、辩论其他模块

通行证管理系统

个人信息管理模块

积分系统模块

好友模块

站内短信模块

分类信息模块

稿件管理模块

博客管理系统

日志模块

相册模块

留言管理模块

博客模板、风格设置模块

圈子模块

活动模块

分类信息系统

分类信息发布

按大小分类、区域进行浏览

显示热门、推荐信息

论坛系统

采用康盛创想（北京）科技有限公司（Comsenz Inc.）的Discuz!论坛系统商业授权版本,并与通行证用户整合,详情请参考Discuz论坛。

程序编制员签名

谢康、陈炜坤、陈卓铭、蔡壮茂、陈思位、梁毅成、彭金龙、马光明、邓铭武、李慧、邝林芳、王海愉

修改完成日期: 2009年8月3日

2.   模块开发情况

略

3.   功能说明

内容支持平台(http://sys.citygf.com)

用户管理模块

用户列表

对所有通行证用户进行管理，根据用户状态、博客状态、推荐博客等条件进行筛选，可批量执行关闭、锁定用户或博客等操作。

实名验证

实名验证分为未处理、审批通过和审批不通过三种状态，默认显示所有未处理，管理员在确认审批不通时可以选择不通过原因。

积分设置

积分设置用于设置前台用户的一些操作动作获得的积分数、如注册、发表一篇日志等，为负分数则减少积分数，保存后需要点击刷新缓存以立即应用所修改后的设置。

等级设置

等级设置用于设定积分数所对应的等级，并将用于博客、通行证、论坛等处显示。点编辑可以修改等级号和积分范围，注意不能和已有积分等级设置的重复，系统计算用户等级是从低到高循环判断，如果积分范围(最小值)<=用户积分<积分范围(最大值)就认为用户属于该级别。

博客管理模块

博客文章管理

可根据博主帐号、文章标题、日期、状态进行搜索，可以进行批量删除、推荐、取消推荐操作。

博文排行管理

显示提交到门户的浏览次数最多的前10篇博文列表，管理员可对不符合要求的进行排除以不在前台博客首页的博文排行处显示。

文章评论列表

可根据博主帐号和留言人IP地址进行搜索，并可对评论执行批量删除。

门户文章类别

用于管理提交到门户的栏目类别，门户栏目编号必须与门户实际栏目的编号一致，否则文章将不会在相应栏目显示出来。

博客相册管理

列表显示所有博客相册，能根据博主帐号、创建日期、门户相册类别和状态进行检索，可执行批量删除、推荐和取消推荐操作。

相册评论管理

对所有博客相册的评论进行管理，可批量进行删除。

门户相册类别

用于管理提交到门户相册类别，门户栏目编号必须与门户实际栏目的编号一致，否则相册将不会在相应栏目显示出来。

博客留言列表

对所有博客留言进行管理，可以根据博主帐号和留言IP地址进行搜索，批量删除。

博客标签

显示博文所有使用的标签列表，可按热门和推荐进行检索，并可批量推荐、取消推荐、设置热门、取消热门、删除。

博客类别

用于博客类别的管理

博客模板

管理所有博客模板，按指定格式上传静态页面和样式文件即可新建博客模板。

圈子管理模块

圈子列表

对所有用户创建的圈子进行管理，可根据圈子域名、圈子名称、圈主帐号、圈子状态进行搜索，并可进行锁定、删除、推荐、取消推荐操作。

圈子文章

显示提交到圈子的所有博文，可根据域名来搜索指定的圈子，删除圈子的文章不会删除原博文。

圈子成员

对所有圈子的成员进行管理，可根据圈子域名查看圈子所有成员或查询会员帐号显示用户加入的所有圈子，并可移出圈子，状态列-1表示邀请等待确认、0等待审批、1正常、2拒绝加入。

圈子留言

对所有圈子留言进行管理，可根据圈子域名、名称、状态、留言IP地址等进行搜索或删除。

圈子类别

可新建、修改圈子类别，如果类别中已有圈子则不能进行删除。

活动列表

对所有圈子的活动进行管理，可根据圈子名、发起人、选项等筛选，操作栏可进行管理和删除操作，点击管理链接可对活动的基本信息、成员、留言进行管理。

活动分类

对圈子活动分类进行管理。

活动留言

对圈子活动留言进行管理，可根据活动名、留言人姓名、IP地址搜索，将选中的留言进行删除。

广告管理模块

客户管理

所有投放的广告必须是属于某个客户，客户管理用于维护所有投放广告的客户。

广告素材管理

投放广告需先新建广告素材，一个客户可以有多个广告素材，一个广告素材也可以投放到多个广告位，广告素材根据展现形式分为图片、文字、Flash、JavaScript、HTML5种类型，图片和Flash类型可以上传其文件，其他类型直接在文本框内编辑。其中文字类型只显示纯文字，JavaScript类型内容应为包含<script></script>标记在内的JavaScript代码，HTML即是为完整html格式的标签。

广告投放列表

广告投放列表用于显示广告素材所投放到的广告位列表，显示机率百分比100表示此广告位恒显示该广告素材，当一个广告位投放了多个广告素材的时显示机率可以控制素材在此广告位显示机率次数。当广告位无素材投放或投放已过期将显示广告位默认广告。

广告效果统计

广 告效果统计为所有已投放的广告素材按天统计在广告位上展示和点击的次数，可查看特定广告素材和广告位的统计情况，如果需要查看某一天请在投放起止日期选择 为同一天，由于广告系统采用缓存池，广告效果统计每一小时候更新到数据库一次，点击刷新数据强制更新到最新的统计数据。

广告位绩效排名

广告位绩效排名可根据广告位的展示或点击次数降序排列统计，是评测某个广告位效果的一种重要依据。

刷新广告池

由于广告使用数据缓存，对于新增加或修改广告素材可能不能及时更新，刷新广告池将前台所有广告更新到最新更改的广告数据。

广告位管理

广告位管理用于维护整个系统的广告位，广告位的ID应该为字母、下划线、数字组成并确保唯一，名称可为中文汉字，可用于检索。新建广告位时应同时指定默认广告，否则该广告位无广告投放时将显示一片空白。

广告尺寸设置

当广告位没有选定大小的尺寸时，可先在广告尺寸设置内添加广告尺寸。在列表页操作栏可进行修改、删除操作，查看广告位将跳转该尺寸应用的所有广告位。

广告频道管理

所有广告位应都所属广告频道，广告频道管理用于维护所有广告频道，查看广告位显示该频道所有的广告位。

论坛版块管理模块

论坛版块管理

论坛板块列表提供论坛和门户栏目的绑定，论坛板块的添加删除请登陆http://bbs.citygf.com后台进行修改，注意子板块不会继承自父板块的门户栏目绑定。

分类信息管理模块

区域设置

区域设置用于设置发布信息时选择的区域，支持两级区域，点击一级区域可查看二级区域，当区域里已有信息发布则不能删除，可点击排前或排后进行排序。

分类设置

管理用于发布信息时选择的分类，支持两级分类，分类中已有信息发布则不能删除，可点击排前或排后进行排序。

分类表单

分类表单用于自定义设置分类字段，可选择输入框、文本框、下拉列表、复选框组、单选框组类型，不同类型在发布和查询时将呈现出不同的控件结构，当类型为下拉列表、复选框组、单选框组时必须添加选项参数。分类自定义表单设置之后，请刷新前台缓存。

信息列表

信息列表是前台所有发布信息的管理中心，可根据分类、区域、审核、置顶、标题、发布人作者进行检索，并可执行批量删除、推荐、取消推荐、置顶、取消置顶、审批通过、取消审批操作。

信息举报

信息举报管理用于处理前台用户对分类信息的举报，并可操作栏在标记为属实或虚假，以便之后再做相应的处理。

评论列表

用于管理所有信息的评论，可根据留言IP地址进行筛选，对于一些广告性质的或恶意评论可进行删除。

点击排行

排行列表显示按点击数排行显示的前100条分类信息，过期的信息将不再这里显示。

审核关键字

当用户提交的信息出现关键字，则信息需要审核才能发布，将要过滤的关键字粘贴在文本输入框区域，多个使用回车换行，点击保存设置即可。

流量统计模块

站点管理

管理用于流量统计的所有站点，获取统计代码用于查看某个用户的JavaScript脚本统计代码。

频道管理

维护所有站点的所有频道

统计报表

1.综合报告

2.最近访客

3.时段分析

4.每日分析

5.IP来源分析

6.来源地区分析

7.搜索引擎分析

8.来源关键词分析

9.来源网站分析

10.被访问页分析

系统设置模块

登陆帐号

列表显示所有登陆内容支持平台(http://sys.citygf.com)的管理员登陆帐户，只有角色高的帐户才能设置角色低的帐户，默认admin为最高权限的帐户。

服务动态

管理显示于博客后台首页的服务动态列表.

非法关键字设置

非法关键词有两类，A类直接替换为星号，B类拒绝发布内容。一行只能输入一个关键词，多个使用回车换行。

非法关键字处理

列表显示捕获的文章、文章评论、>留言、信息、评论、留言、相片评论包含关键字列表，可对一些误捕获的文章或评论进行排除通过，而对一些确实违反道德或国家法律的文章或评论进行删除。

投稿、举报、辩论其他模块

投稿管理

对前台用户在线投稿的文章进行管理，可根据用户帐号、分类、状态进行搜索，点击进入稿件可以查看稿件改动过所有的历史版本，并可设置审核通过或不通过。

投稿分类管理

对投稿分类进行管理。

举报管理

对前台用户进入http://public.citygf.com/alarm/index.aspx举报的信息进行管理，可根据举报人、IP地址、类别、处理状态进行检索，标记为属实或不属实后再进行相关操作。

举报分类管理

对举报分类进行管理。

辩论管理

对辩论进行管理，验证方式为Cookie的即在客户端值入一个Cookie来标识已投票，IP验证则保留IP到数据库以保证每次参加辩论者IP的唯一。

辩论评论管理

对辩论的评论进行管理，可根据辩论标题、评论人、IP地址、支持方进行检索，并可执行批量删除操作。

通行证管理系统(http://public.citygf.com)

个人信息管理模块

修改个人资料

修改用户的基本资料。

上传个性头像

用户个性头像，将用于博客、论坛、圈子等多出头像的显示。

实名验证

用于网络实名验证，需要填写真实姓名、身份证号码，上传证件图片，验证通过后不许更改。

我的积分

显示我所有积分获取的历史记录，为负分数是减少积分。

好友模块

我的好友

显示已经审核通过了的好友列表。

添加好友

用于添加好友，对方帐号必须不为空且存在，备注信息为对方审核时看到的信息，非必填。

站内短信模块

撰写短信

接收者帐号不能为空且确保用户已存在，点击右边可选择发送到的好友。

我收到的短信

显示我所有收到的短信，可根据好友帐号查找短信，已读短信显示为灰色图标。

我发送的短信

显示我发送到好友的短信和系统自动发送的短信息，如好友申请和加入圈子申请等，可选择短信进行批量删除。

分类信息模块

管理分类信息

管理在http://fenlei.citygf.com上发布的所有分类信息，可进行编辑和删除操作。

发布分类信息

跳转至http://fenlei.citygf.com/pub.aspx发布分类信息页面

稿件管理模块

管理我的稿件

管理我所有投放过的稿件列表，可根据审核和发布状态进行检索。

在线投稿

只有登陆了通行证用户才能在线投稿，且稿件内容不能少于200个字，未选发布的稿件后台管理员不会看到。每次编辑稿件后将保留历史稿件内容记录，并版本号自动加1。

安全设置

修改我的登陆密码

先输入正确旧密码，输入新密码并再输入新密码，密码强度指示新密码的评级，建议使用数字+字母+符号的强类型密码。

退出登陆

安全退出通行证帐号。

博客管理系统(http://blog.citygf.com)

日志模块

添加日志

日志自动生功摘要将从日志内容中提取前若干字作为摘要内容，需要保持原摘要或手工编辑,请不要打勾，草稿只在管理列表显示，不会在博客页面显示。

日志列表

用列表上的搜索工具条可对列表中的文章进行过滤，可批量选择删除、置顶、取消置顶。

添加栏目

栏目支持两级分类，如果设置了“栏目图片”，在首页显示栏目文章时，不仅会显示该栏目的文章列表，还会显示一张图片，可使页面排版更美观，建议上传符合栏目特点和内容的图片。

栏目列表

显示我的栏目列表，栏目排序由排序号从低到高排列，如需要设置请在修改里操作。

相册模块

上传相片

点击批量上传相片可同时添加5张相片进行上传，最大只允许上传2M的文件, 图片的宽度最好小于640px。

添加相册

添加相册后，您所添加的该相册的第一张照片会成为该相册得封面图片，如果选择提交到总站频道，则需要经过管理员的审批之后才能发布。

相册列表

管理我博客的相册列表，可进行预览、继续上传、修改和删除操作。

网络文件夹

显示我对应的网络文件夹列表，包含个人头像、相册图片等文件，如果删除一些所需资源文件将导致一些不正常的行为，如照片不显示等。

留言管理模块

博客留言管理

管理我的博客留言，可批量进行删除，您可以对留言进行回复，回复内容会以“博主回复”形式显示在该条留言内容里。

文章评论管理

文章评论显示的是浏览者对您的某些日志,文章做的评论，可以以"博主回复"的形式回复浏览者的评论，并可批量选中进行删除。

相片评论管理

显示博客相片的所有评论列表，并可批量进行删除。

博客模板、风格设置模块

页面版式设置

设置博客不同的版式，可以将博客分为两栏(左栏、右栏)或者三栏.注意:如果设置成两栏。那设置的在右栏的模块将无法显示。

模块设置

设置博客首页显示的模块，可控制名称、是否显示、排序、分布左右等，支持添加自定义模块内容。

显示模式设置

设置前台的文章列表的显示形式改变,两种选择,一种是列表的形式,一种是摘要的形式。

博客摸板设置

选择不同的模版，将呈现出不同的风格、样式，点击图片进行预览。

圈子活动管理

加入圈子

可根据省市、圈子类别、名称进行查找，并可浏览或加入圈子。

我的圈子

显示我加入的圈子列表，并可查看浏览或退出圈子，如果是创建者则是管理圈子，包含圈子基本信息、装饰、成员、邀请审批用户、公告、友情链接、文章栏目、文章、留言的管理。

新建圈子

创建一个圈子，圈子域名必须是唯一的且不存在。

活动报名

显示我已加入的圈子所有活动列表，如果圈子未到期或关闭则可申请加入。

我的活动

显示我加入的活动列表，如果是活动发起人则可管理活动，包括基本信息、成员和留言的管理。

发起活动

添加自己圈子内的活动，如果无圈子请先创建一个。

圈子模块(http://group.citygf.com)

圈子前台首页展示，包含精华博文、最新博文、活动、自定义栏目、成员、留言，后台在博客管理后台。

活动模块

在圈子的活动栏目，列出所有圈子的活动，点击进入活动详情可发表留言、活动报名，活动管理后台在博客管理后台。

分类信息系统(http://fenlei.citygf.com)

分类信息发布

发布信息步骤：1.选择大类 < 2.选择小类 < 3.选择区域 < 4.填写信息。标题字数在6到30个字符之间，描述必须为10到800个字符，所有带*号的为必填项。

按大小分类、区域进行浏览

信息分类模块列出了所有的大分类及其对应的小分类，点击链接进入可选择区域列表，并可以根据后台自定义表单字段进行检索。

显示热门、推荐信息

首页显示所有系统推荐信息、按点击数排序的热门信息、按评论数排序的热门点击信息，进入某个分类或信息则显示本类热门和推荐信息。

4.   设计说明

内容发布管理系统

门户网站前台静态页面处理核心部分，使用WCM内容发布管理系统，通过使用模板生成前台静态页面，并提供评论、在线直播等互动插件。

内容支持平台

博客、通行证、分类信息等系统的总管理后台，解决方案PORTAL项目按功能菜单分文件夹页面，其中WebInf下面提供用户、博客、论坛调用的公共接口，详细说明如下：

博文排行

通行证管理系统

提供同步登录、退出、注册等相关接口，可以实现用户一个账号，在一处登录，全站通行。系统登陆采用写入citygf.com域名Cookie的办法,所有二级域名均共享能访问，并且使用MD5进行加密验证，确保帐户认证安全。

提供积分通用调用的WebService接口，地址http://public.citygf.com/PointService.asmx，提供funcAddPoint、funcAddPointByBbs、funcAddByAdmin方法，供博客、论坛等多处发表文章、帖子增加积分时调用，出与权限安全的考虑，该WebService接口方法只能在服务器端本机被调用。

博客模块

博客系统采用URL伪地址，将类似http://blog.citygf.com/帐号/index.aspx格式的URL地址进行RewritePath重写处理，简洁方便让URL更加友好，此技术还同时应用在了圈子、分类信息等处。系统监视每个发生错误请求的事件，将时间、IP地址、错误页面、引用页面地址，错误详情等记录到网站根目录Error.log文件内，方便管理员分析查看。

分类信息系统

分类信息系统采用自定义表单，可针对不同的分类进行自定义设置，在发布或搜索的时将做为分类信息的输入属性条件，当每添加一个自定义表单字段的时候将在数据库新建一个名为’FA_Info_Field_分类编号’的表，用来存储自定义表单字段值。

论坛模块

采用康盛创想（北京）科技有限公司（Comsenz Inc.）的Discuz!论坛系统商业授权版本，并与通行证用户整合，在论坛的个人信息处同时显示用户Logo及个人博客、相册、加为好友、发送短信的链接，发表或回复帖子调用相应WebService接口增加通行证用户积分。

5.   原代码清单

略

6.   测试说明

7.   复审的结论