1、1产品文档新闻客户端需求说明书2修改记录版本 作者 描述 修改日期1.0 王灵杰 完成了基本需求文档 2014.101.1 王灵杰 对设计与技术提出来的一些问题做了修改2014.11.191.2 廖星 完善技术参数 2014.11.201.3 王灵杰 增加了交互逻辑 2014.11.223目 录1. 文档介绍 - 51.1. 文档目的 - 51.2. 文档命名说明 - 52. 产品介绍 - 62.1产品开发背景原因 - 62.2产品信息介绍 - 62.3产品用户定位 - 62.4产品中的角色 - 73.产品信息结构图 - 84.功能需求 - 94.1管理账户 - 94.2用户账户 - 94.3
2、用户设置 - 104.4个人中心 - 114.5栏目功能 - 114.6内容添加功能- 124.7评论功能 - 124.8搜索功能 - 134.9分享功能 - 134.10图片栏目 - 1344.11补充说明 - 145.非功能需求介绍 - 145.1运行环境 - 145.2可用性 - 145.3可扩展性 - 155.4安全性 - 155.5接口 - 156.交互逻辑 - 166.1客户端界面逻辑 - 166.2管理后台界面逻辑 - 177.项目组成员分工 - 178.预期目标及要求 - 179.附件 - 1851.文档介绍1.1 文档目的该文档用于武汉理工大学校园新闻客户端产品开发文档，用于
3、开发，设计，测试团队之间的交流基础。包括对于产品前端界面，交互逻辑，以及后台开发的一些规范。1.2 文档命名说明产品名称：武汉理工大学新闻客户端文档名称 说明 备注一级页面 包括首页，订阅等固定在底部的页面二级页面 从一级页面能直接进入的页面 之后的页面也同样一级用户 校园卡登录的用户二级用户 社交帐号登录的用户三级用户 没有登录的用户最高管理员 有所有权限的管理员 建议 5 个以内一级管理员 能添加，发布信息。并且添加新管理员 部门负责人二级管理员 只能添加消息 编辑62.产品介绍2.1产品开发背景原因14 年 10 月，因新浪与微信合作推广基于微信的校园号，向学校提出为学校搭建微信校园号，
4、具体功能包括新闻客户端，学生信息查询等。考虑到今后合作成本及互联网信息发展移动化的趋势，党委宣传部决定由 Token 团队开发一款校园新闻客户端的移动软件，并由单独的内容采编团队来进行产品后期的内容的添加于维护。2.2产品信息介绍产品有一只学生内容团队负责其内容的更新，其中包括采编，约稿等多种形式。集校园生活，时事热点，学生问题，自由评论等多栏目为一体的移动端 app，为校内师生更好的推送方方面面的新闻资讯。同时也是由高校信息向社会发散的一个平台.2.3产品用户定位该产品主要面向三类人群，武汉理工大学在校学生，武7汉理工大学所有教职工，社会上关心或者想了解学校的人员。三类人员对客户端中的资讯需
5、求程度不一样，在内容推送与分类上需要慎重。2.4产品中的角色角色名称 职责 备注技术开发组 提供技术支持，包括功能实现，维护改版等运营人员 根据产品情况提供运营报告，并策划产品推广方案产品运营 确定产品内容定位，收集用户反馈，积极完成产品迭代内容管理 确定内容团队中的人员，对产品发展方向把控内容维护 确定内容，稿件审核，发布，联系稿件来源，并做好内容团队的培养83.产品信息结构图最高管理员栏目分类。修改一级管理员二级管理员用户权限开始二级管理员采编，添加一级管理员发布否是结束存放在后台，仍可发布内 容 发 布 方 式94.功能需求4.1 管理账户4.1.1 最高权限管理员对栏目进行禁用，新增操
6、作；更改栏目性质（详见栏目性质说明）可以分配子管理员账户（包括一级/二级管理员） ；具有所有一级管理员权限4.1.2 一级管理员能发布待审核的稿件；可以分配二级管理员账户；具有所有二级管理员权限；4.1.3 二级管理员在后台添加稿件；更改稿件性质（详见稿件性质说明 ）4.1.4 管理员帐号说明管理员帐号为邮箱帐号；密码单独设置；管理员信息包括姓名，电话；4.2 用户账户4.1.1 用户账户级别校园卡号，学号，经纬帐号登陆（一级用户） ；社交账号登陆（二级用户） ；没有登陆（三级用户） ；4.1.2 一级用户查看，评论所有可评论的内容；10绑定社交帐号后可分享所有内容；4.1.3 二级用户查看，
7、评论指定栏目内容分享指定可分享的内容绑定校园卡号之后升级为一级用户4.1.4 三级用户只能查看，指定对所有用户开放的内容不允许评论登录社交帐号后成为二级用户4.3 用户设置4.3.1 一级二级用户可自定义头像，签名，昵称允许修改一次（个人中心中设置）4.3.2 浏览模式分为日间/夜间4.3.3 用户可自定义文字大小以大中小按钮操作4.3.4 默认自动加载图片，自定义是否在 2G/3G/4G 状态下自动加载图片4.3.5 默认自动缓存所有浏览过内容的文章，用户可自义是否在 2G/3G/4G 状态下自动缓存。4.3.6 用户可一键清理缓存文件4.3.7 可管理收藏文章，点击收藏进入4.3.8 可进
8、入个人主页，在个人主页中设置主页是否对其他人开放，默认为开放4.3.9 有反馈选项，用户可实时向管理员反馈114.3.10 版本及产品相关信息4.4 个人中心4.4.1 可查看本用户所有评论，及收藏的文章（按时间排序）4.4.2 在个人中心设置是否对外开放，默认是4.4.3 个人中心中可修改头像，签名，昵称只允许设置一次新用户登录后在第一次评论时跳出设置昵称弹框。4.4.4 个人中心有注销登录按钮4.4.5 一级用户登录状态时有绑定社交账号按钮4.4.6 二级用户登录状态时有绑定校园卡号按钮4.4.7 三级用户的个人中心页面有跳转登录按钮4.5 栏目功能4.5.1 后台可添加任意数量栏目4.5
9、.2 新增栏目的时候选择栏目属性栏目属性分为，对一级用户开放，对所有用户开放，允许二级用户评论，允许一级用户评论，不允许评论新增栏目的时候默认栏目对所有用户开放，允许一级用户评论4.5.3 后台栏目顺序在界面上显示顺序为从左到右，从上到下Comment 廖廖1: 需要规定新闻的类型，并详细说明每种文章类型的属性，比如class 新闻 public 栏目public 标题public 来源public 作者public 摘要public 缩略图public 关键字public 发布时间private 状态=enum(待审,发布 ,禁用)private 评论=enum(No,1,2,All) cl
10、ass 文字新闻 extends 新闻 public 详细内容class 图片新闻 extends 新闻 public Array图片=class 图片public 图片地址public 图片描述并且，新闻内容中可包含图片、视频等媒体。124.5.4用户首次进入时登陆后进入订阅页面，以后打开后为首页4.5.5用户订阅栏目后显示在首页4.5.6用户自定义栏目顺序及数量4.5.7栏目订阅方式待定4.6内容添加功能4.6.1添加内容时需要指定栏目4.6.2添加内容可以选择文字，图片，语音，视频，文件4.6.3每篇内容的属性与栏目一致，所有管理员均可修改4.6.4 内容属性分为，对一级用户开放，对所有
11、用户开放。允许二级用户评论，允许一级用户评论，不允许评论， 分享权限与评论一致。4.6.5内容发布后支持修改，禁用4.6.6内容的发布步骤为，添加-审核（禁用）-发布成功4.7评论功能4.7.1内容二级页面底部固定写评论看评论按钮，均跳转到13新页面4.7.2 评论区可定义顺序查看/倒叙查看4.7.3 评论不能回复，只能盖楼4.7.4 可通过其他用户评论点击进入其个人主页4.8 搜索功能（可行性待定）4.8.1 关键字显示某篇新闻（能搜索标题或内容）4.8.2 搜索功能固定在首页底部4.8.3 搜索界面为一个单独的页面4.9 分享功能4.9.1 内容的二级页面底部固定分享按钮，可分享至主流社交
12、平台4.9.2 绑定帐号后的用户可直接分享，在分享时登录社交帐号的用户默认绑定校园卡或升级为二级用户4.10 图片栏目4.10.1 图片每篇内容时必须有总的描述4.10.2 多张图片发布时可对每张图片描述，描述在用户点开大图时不会出现Comment 廖廖2: 新闻结尾推荐暂采用前后篇的形式，待迭代时改进144.10.3图片内容的界面形式与文字不一样4.11补充说明 4.11.1后台编辑保证 Tab键= 四个空格键5非功能需求5.1运行环境5.1.1操作系统：CentOS 7 64位5.1.2运行环境：PHP + Nginx + MySQL5.2可用性5.2.1用户能够简单的浏览想要关注的内容，
13、并发表评论，登录，注销，并以较好的形式来完成整个阅读过程5.2.2后台维护人员能几乎以零学习成本来使用管理后台，并能较高效的完成工作5.2.3运营人员能以可视化的界面获取相关数据5.2.4保证其中某些内容的私密性（校内网内容的安全性）155.3 可扩展性5.3.1 后台程序基于 ThinkPHP 开发，需要遵循低耦合原则，实现框架核心与领域逻辑的分离。并且需要遵循里氏替换原则，保证类的可继承性，便于功能扩展。5.4 安全性5.4.1 后台接口需要对传入的所有数据进行合法性检查和注入规则检查，以及逻辑关系检查，保证客户端提交的数据合法。同时前端也需要做好相应过滤处理，并给出友好的提示。同时，学号
14、密码等敏感信息在传递时需要采用加密传递的方式，保证信息安全。5.5 接口5.5.1 接口需要方便调用，保证编码的一致性。5.5.2 后期运营数据除了基于统计平台的数据，应该包括以下几点（优先级较低）1）每篇内容的浏览次数2）每篇内容的评论次数3）不同属性的用户数量4）不同属性的管理员账户（一级 /二级）添加和发布数量5）运营人员能直接可视化的界面上下载或者看到选定日期内的数据6）数据形式最好为 excel 格式。或者其他待定166.交互逻辑6.1 客户端界面逻辑6.1.1 登录界面，用户登录或游客模式6.1.2 第一次用户进入为订阅页面，选择感兴趣的栏目6.1.3 订阅完成后进入首页，在非图片
15、部分侧滑为栏目之间切换，在上方图片部分策划为该栏目内图片的切换，第一版计划每个栏目图片为三张。6.1.4 首页底部有三个按钮，分别为“ 首页 “， “订阅”， “设置”6.1.5 设置页面包括个人中心，图片加载模式，文章缓存模式，清除缓存，字体设置，浏览模式（日间/夜间） ，关于我们，向我们反馈。6.1.6 个人中心包括头像，签名，昵称，我的评论，我的收藏（评论收藏只显示一条，均有子页面）注销登录按钮，注销登录后跳转到登录界面。6.1.7 关于我们中包括产品信息与团队介绍。6.1.8 内容二级页面包括顶部的栏目名称，内容，底部按钮6.1.9 底部按钮功能为“ 分享”， “收藏”， “评论”，
16、“模式“ （模式17用于调整字体大小，浏览模式）6.1.10 所有操作无法完成的时候应该有提示性语句。6.2 管理后台界面逻辑（待定）6.2.1 登录界面（最高权限管理员第一次登录，然后分配账户）6.2.2 登录完成后，可进行设置栏目，分配子帐号，添加稿件。各栏目稿件列表，发布稿件等动作。6.2.3 添加稿件完成后进入列表页面，可选择发布。6.2.4 所有功能均有权限限制， 操作无法完成的时候有提示7.项目组成员分工1）设计 王帅兵，袁红霄2）Java/Andriod 潘建峰，杨晨3）管理后台 廖星，陈亚辉 4）oc/ios 龙志辉，张浩浩5）产品 王灵杰8.预期目标及要求1） 新闻客户端能稳定运行，错误数/启动次数 =10 篇/天？）4） 页面逻辑无错误5） 发布国内主要平台市场。6） 客户端数据能直接以可视化的界面显示7） 确定各个栏目与内容的性质，并详细说明9.附件9.1 第一版原型图9.2 设计初稿9.3 设计定稿
