研发博客需求文档v10.docx

1、研发博客需求文档v10研发博客需求文档v1.02015-8-211.引言1.1.目的本文档对研发博客在功能要求等各方面做了详细的说明分析，作为研发博客开发过程中的基本依据，帮助开发人员了解研发博客的功能需求和系统架构，便于对往后的技术选型与相关的开发文档编写做出明确的指导。预期读者：研发中心2013、2014级全体成员1.2.项目背景系统名称：研发博客任务提出者：研发中心2013级成员项目负责人：研发中心2013级成员开发人员：研发中心2014级后台，安卓，前端组成员1.3.术语说明报表：在此处只考虑excel表。wifi 管理平台：工一617极路由后台管理系统2.系统概述2.1.目标建设研发

2、官方博客，一方面为研发中心建立一个对外官方平台，方便以后完成宣传，招新等工作；另一方面，2014级研发新成员初进研发，掌握的理论知识与开发经验有限，在建设研发博客的过程中能补充各方面的知识，为日后开发更高难度的项目作一个良好的过渡。另外，该平台旨在为研发各成员提供相互学习交流的机会，合理利用研发博客，记录自己的学习与大学生活，共同努力为研发争取更多的荣耀，把研发建设为一个更高水平的团队。2.2.用户特征本系统面向的用户主要为研发中心历届成员以及其他编程爱好者。2.3.系统架构B/S和C/S是目前开发模式架构的两大主流技术，B/S可操作性强，维护容易，但无法快速操作；C/S模式操作方便，但操作功

3、能有限。本系统同时采用B/S 与 C/S 模式，其中C/S模式只应用于移动端。3.需求分析3.1.概述研发博客可分为前台和后台两大系统。前台系统对内给研发成员撰写博客，分享代码等；对外介绍研发以及展示研发风貌。后台管理系统主要管理本系统的用户与系统提供的服务，另外后台管理系统集成wifi管理平台，对各成员在工一的学习时间作统计。前台系统主要包括七大模块：1用户管理：用户管理自己的账号。不对外公开。2首页展示：展示采集的最新科技资讯以及站内优秀内容，另外在该模块简要介绍研发。对外公开。3博客浏览：按照各种分类展示站内的博文。对外开发。4代码分享：分享新实现的功能，比如安卓的组件，前端的动画，C+

4、的小游戏，后台很深奥的东西等都可以分享。给其他成员交流学习提供一条捷径。不对外公开。5照片墙：研发各种表情包。不对外公开。6个人中心：用户撰写博客以及管理个人的信息。不对外公开。7关于研发：详细介绍研发以及让他人给系统留言。对外公开。后台系统主要包括八大模块：1用户管理：管理员管理所有的账号信息，配置账号角色及权限。2首页管理：更新首页展示内容。3博客管理：根据用户写的博客调整系统提供的与博客相关的服务，统计发博文情况。4分享管理：根据用户分享的内容调整系统提供的与代码分享相关的服务，统计分享情况。5照片管理：调整用户上传的照片。6关于研发：更新前台系统中关于研发模块展示的内容。7消息管理：处

5、理留言以及向用户推送消息。8学习时间：统计各人各组各年级在工一的学习时间。3.2.前台系统3.2.1.用户模块用户模块主要负责用户账号的常规管理，包括注册登录与修改密码等基本操作。通过前台系统的账号管理配合后台系统的账号管理来实现严密的权限控制。3.2.2.首页模块科技人员都应时刻关注科技的新动向，了解最新的技术，拓宽自己的视野。首页模块核心内容就是最新的科技资讯和站点内优秀的博文或代码分享，另外首页应有对研发中心的简单介绍。首页全部内容由后台管理员设置。3.2.3.博客模块博客模块主要用于用户浏览博客以及与博主相互交流。博客模块是本系统中的一个比较重要的模块，需要和个人中心模块中的博客管理相

6、呼应，应做到界面对用户友好，功能灵活多样，并且用户可以十分方便地切换到其他分类下的博文界面。3.2.4.代码分享模块代码分享模块是研发内部交流最直接的模块，因为程序员都用代码说话。每个成员都可以把新学的东西写成一个demo，上传完整的代码到代码分享模块，记录自己的学习同时为他人提供一个方便快捷的入门途径，加强同一个小组间和不同组别间成员的交流，解决隔组如隔山的现状。优秀的代码可以公开到首页供研发外部其他访问者浏览，其它代码只在研发内部分享。3.2.5.照片墙模块照片墙集结研发各种表情包，平时大大小小活动或者日常所拍的照片都可以放上去，但要建立良好的分类管理机制，以免浏览时图片过于零散。另外，非

7、研发内部成员无法看到所有图片，管理员可以设置部分图片公开，作为外部人员了解研发的另外一种途径。3.2.6.个人中心模块个人中心模块只供研发内部成员操作，包括个人资料的修改，接收消息，管理自己的博客、上传到照片墙的图片和分享的代码等功能。研发内部非管理员成员只能操作自己的个人中心，管理员除了能管理自己的个人中心，还能操作其他人的个人中心部分功能。3.2.7. 关于研发模块关于研发模块中详细介绍了研发的情况，外部人员也可以在此模块给系统留言。3.3.后台系统3.3.1.用户管理模块后台系统中的用户管理模块与前台系统的用户模块相对应，超级管理员可以管理每一个用户账号，包括查看、修改、删除用户信息，另

8、外可以配置部分账号为分组管理员，并分配一定的权限。此外，该模块还管理所有用户登录注册日志。3.3.2.首页管理模块首页管理模块负责更新前台系统中首页的内容，包括定时更新科技资讯，优秀博文的推荐等。3.3.3. 博客管理模块博客管理模块可以对系统中与博客相关的内容进行修改，例如系统默认的博客分类和标签等，另外可以统计博客相关的信息，如各组，各年级的发博文情况等，对用户使用研发博客的情况作直观的展示。在该模块中还可以查看、删除每一篇博文，但删除博文后要通知博主。3.3.4. 照片墙管理管理员在该模块管理每一张图片，譬如设置部分图片作为公开图片贴在照片墙中，或者删除部分存在不良影响的图片。3.3.5

9、.代码分享管理代码分享管理模块与博客管理模块大体功能相似。3.3.6.关于研发管理更新研发的详细介绍。3.3.7.消息管理处理留言和向用户推送系统消息。3.3.8.学习时间管理将工一617 wifi管理平台接入本系统，统计各位成员在工一的学习时间，并用报表直观显示。4.功能详细设计4.1.前台系统4.1.1.用户管理注册注册页面只提供给研发内部成员。用户填写必要的注册信息，若注册信息合法则可注册成功，系统发送一次性账号激活链接到注册时填写的邮箱，激活链接24小时内有效，若账号激活成功则系统自动为用户登录，进入个人资料页面，系统引导用户完善个人信息，若账号激活失败则提醒用户重新注册；若注册信息不

10、合法则注册失败，在当前页面返回错误信息。登录用户输入姓名，密码，点击登录，若匹配正确则登录成功；若匹配失败则在当前页面返回错误信息，连续5次登录失败需要填写验证码，连续10次登录失败当天内无法再登录。退出登录注销登录账号，跳转到首页。修改密码用户输入旧密码，新密码，确认新密码，若输入合法则可修改成功，注销登录账户返回首页；若输入不合法则修改失败，在当前页面返回错误信息。找回密码用户输入注册时的填写的邮箱，系统发送含有临时密码的邮件到用户邮箱，临时密码为8位英文或数字组成的字符串。会话设置游客想要执行评论或留言等操作时，需要先设置本次会话信息，包括昵称与邮箱，本次会话结束该信息则变成无效，可以选

11、择记住该会话信息，默认3个月。4.1.2.首页展示浏览科技资讯点击资讯标题，查看资讯详情。资讯从其它网站采集，暂时无法确定资讯详情所包含的内容。浏览优秀博文点击博文标题，查看博文详情。博文详情在4.1.3 博客浏览中做详细规定。浏览优秀分享点击分享标题，查看分享详情。分享详情在4.1.4 代码分享中做详细规定。4.1.3.博客浏览筛选博文用户选择博文分类或博文标签即可切换分类/标签，获取对应分类/标签下最新的10篇博文。若选择的分类有子分类，则在博文分类版块中显示对应的子分类；若选择的分类没有子分类，则博文分类版块不变。在当前分类处可由子分类切换到父分类。查看用户所有博文在博客筛选页面点击博主

12、头像可进入该用户个人的博客中心，查看其所有博文。查看用户个人中心在用户博客中心页面点击用户头像可进入该用户的个人信息中心，该功能只面向研发内部成员。信息中心页面在4.1.6.1 信息中心作详细规定。留言在用户博客中心页面可以向博主留言，只有已登录用户或已设置会话信息的用户才能留言，博主可在个人消息中心查看留言。消息中心页面在4.1.6.4 消息中心作详细规定。浏览博文详细内容在博客筛选页面或用户的博客中心点击标题可查看博文的详细内容。评论已登录用户或已设置会话信息的用户可以在博文详细页面评论博文或者评论用户的评论。若用户评论的是博文，则只有博主可以收到评论；若用户评论其他用户的评论，则被评论用

13、户与博主都可以收到评论。若被评论用户是游客时，系统发送邮件给该游客，邮件中提供评论的地址。评论只需显示最直接的关系，即只需显示 XXX 评论博文或 XXX 回复 YYY 的评论。下载所有用户都可下载博文中的附件。收藏与点赞在博客筛选页面、个人博客中心页面、博文详细页面均可点赞与收藏博文。点赞功能面向已登录用户或已设置会话信息的用户；收藏功能面向已登录用户。4.1.4.代码分享此模块只向已登录研发成员开放。筛选分享用户选择分享分类或分享标签即可切换分类/标签，获取对应分类/标签下最新的10份分享。查看用户所有分享在分享筛选页面点击博主头像可进入该用户个人的分享中心，查看其所有分享。查看个人中心参

14、照4.1.3 博客浏览。留言参照4.1.3 博客浏览。浏览分享详细内容在分享筛选页面或用户的分享中心点击标题可查看分享的详细内容。评论参照4.1.3 博客浏览。评论用户不包含游客。下载收藏与点赞4.1.5.照片墙查看图片若用户是游客，则显示公开的照片；若用户是研发内部成员，则按主题（分类）显示所有照片。研发内部成员可以查看自己上传的所有图片。上传图片每位研发成员都可以把图片上传到主题中，包括自己创建的主题和其他用户创建的主题。删除图片图片上传者可以删除自己上传的图片，主题创建者可以删除自己创建的主题，若自己创建的主题包含其他用户上传的图片，在删除主题的同时系统推送消息告知图片的上传者。保存图片

15、下载图片到本地。评论参照4.1.4 代码分享。4.1.6.个人中心4.1.6.1.信息中心查看和修改个人信息4.1.6.2.博客中心新增博文用户填写必要的博文信息即可发布新博文。包括博客标题，正文，系统分类（只可选一个）。另外可以选择系统标签、个人分类与标签或上传一到两个附件（大小暂无限制），个人分类标签各不超过三个。删除博文把博文移到回收站，同时系统推送消息告知博文的收藏者。查看博文与4.1.3 博文浏览中的相关功能一致。修改博文包括修改博文正文、所属分类、标签等。修改后系统推送消息告知博文收藏者。移到草稿箱把正在编辑的博文移到草稿箱。草稿箱中的博文可选择继续编辑，移到回收站或永久删除。增删

16、查改个人分类与标签若博文中采用了用户想要修改或删除的分类或标签，则无法修改或删除。查看收藏的博文取消收藏博文4.1.6.3.分享中心参照4.1.6.2 博客中心。新增分享用户填写必要的分享信息即可发布新分享。包括分享标题，效果描述（文字必须，图片可选），13个核心代码块，系统分类（只可选一个），下载demo。另外可以选择系统标签、个人分类与标签或上传多张效果描述图片（单个文件5M以下），个人分类标签各不超过三个。删除分享查看分享修改分享移到草稿箱增删查改个人分类与标签查看收藏的博文取消收藏博文4.1.6.4.消息中心查看消息消息包括系统消息、游客的留言、内部成员的留言。只有内部成员的留言可以直

17、接回复，实时更新。（相当于私信）查看未读评论查看评论详细内容需要跳转到源主题。查看收到的评论查看发表的评论4.1.7.关于研发查看研发详细介绍获取管理员在后台管理系统编辑好的内容。留言已登录用户或已设置会话信息可以向系统留言，系统管理员在后台管理系统中查看留言。4.2.后台系统4.2.1.用户管理配置角色超级管理员可以增删查改角色并设置角色权限。为账号设置角色超级管理员可以通过把用户账号绑定到某个角色上，将该用户设置为超级管理员或分组管理员，分组管理员只能新增对应的分组管理员。超级管理员具有所有权限，分组管理员只对对应分组具有操作权限。查看登录注册日志只有超级管理员才能查看登录日志。管理用户账

18、号管理员可以查删改用户的信息。修改或删除用户信息的同时推送消息告知用户。4.2.2.首页管理更新科技资讯管理员通过填写url到资讯采集入口，定时将有价值的资讯录入系统。查看历史首页资讯、博文、分享管理员可以按时间查看往期的首页内容。4.2.3.博客管理博文管理超级管理员拥有查看和删除所有用户博文、设置博文为首页博文或把首页博文设置为非首页博文的权限。分组管理员只拥有对应分组下的操作权限。删除或把博文设置为首页博文时应推送消息告知博主。若博文曾经被设置为首页博文，系统应提醒管理员。分类管理所有管理员可以增删查改系统提供的博客分类与博客标签。若用户的博文采用了要修改或删除的分类与标签，则无法修改或

19、删除该分类与标签。统计以折线图扇形图柱状图等方式统计各组，各年级，各时间段的发文数量，博文浏览量，评论数，推荐数。报表生成将某时间段内相关的个人统计生成报表并导出。4.2.4.消息管理查看留言只有超级管理员可以查看或删除用户给系统的留言。查看系统消息超级管理员可以查看系统发送给用户的所有消息，分组管理员只能查看自己发送给用户的消息。推送消息所有管理员都能向用户推送消息。若用户是研发内部成员，则用户可以在个人消息中心接收系统消息；若用户是游客，管理员需要发送邮件到游客的邮箱。4.2.5.照片管理查看删除图片所有管理员都有权限查看和删除用户上传的图片。删除图片时应推送消息告知图片上传者。公开图片所

20、有管理员都有权限把图片设置为公开或把图片设置为不公开。设置图片公开时应推送消息告知图片上传者。4.2.6.分享管理参照4.2.3 博客管理。分享管理分类管理统计报表生成4.2.7.关于研发管理更新研发介绍更新研发成绩更新研发方向4.2.8.学习时间管理查看学习时间按时间查看每个成员在工一的学习时间。统计以折线图、扇形图、柱状图等方式作统计。报表生成导出某时间段内个人在工一总学习时间的报表。5.页面信息5.1.首页5.2.博客筛选页面5.3.个人博客中心5.4.博文详细页面5.5.新增博文页面5.6.回收站新博文 5.7.分享筛选页面6.开发难点难点一：采集科技资讯与接入wifi管理平台需要用到的爬虫技术难点二：留言、私信或评论的实时通知难点三：权限管理难点四：大量图片的处理难点五：统计图表与报表生成