做軟件開發是有那么一套國准可參照的，當然就是那些文檔了，這里列出一下所有軟件開發的規范文檔：
- 操作手冊
- 用戶手冊
- 軟件質量保證計划
- 軟件需求說明書
- 概要設計說明書
- 開發進度月報
- 測試計划文檔
- 測試分析報告
- 數據庫設計說明書
- 軟件配置管理計划
- 模塊開發卷宗
- 詳細設計說明書
- 項目開發總結報告
我現在再做的東西是數據庫設計說明書，兩天前才寫玩模塊開發卷宗，那時候在網上找了一些事例不是很符合規范，而完全對着模塊開發卷宗的模板去寫真不知道里面要寫什么，因為里面有太多概念性的東西都看不懂，在這里貼以下廣佛都市網的模塊開發卷宗，僅供參考。
模塊開發卷宗（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接口增加通行證用戶積分。