文档_文档管理 - CSDN
  • 软件开发常用文档(16个文档),包含:项目开发计划;可行性研究报告;软件文档;概要设计说明书;软件需求说明书;数据库设计说明书;详细设计说明书;测试计划。。。。。。
  • 项目开发文档编写规范

    万次阅读 多人点赞 2018-05-13 17:50:38
    在开发项目的过程中,我深刻的意识到,文档存在的意义并不是无用的报告,简洁明了的文档不光能记录你当下所做的,还能在繁重的工作中分神思考下一步该做什么时为你节约精力,并且在项目周期内,使整个项目保持一致性...

    前言

    在开发项目的过程中,我深刻的意识到,文档存在的意义并不是无用的报告,简洁明了的文档不光能记录你当下所做的,还能在繁重的工作中分神思考下一步该做什么时为你节约精力,并且在项目周期内,使整个项目保持一致性。所以,软件开发文档的编写是很有必要的。我参考网上的资料,结合自己项目开发时的心得,分享一些经验。

    文档类型

    在项目开发过程中,应该按要求编写好十三种文档,文档编写要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。同时依照项目人员的角色划分,完成不同类型的文档。以下排序并未严格按照时间排序。

    类型说明

    可行性分析报告(产品人员)

    可行性研究报告的编写目的是:说明该软件开发项目的实现在技术、经济和社会条件方面的可行性;评述为了合理达到开发目标而可能选择的各种方案;实施方案的利弊;说明并论证所选定的方案。

    项目开发计划(产品人员)

    软件项目开发计划即为软件项目实施方案制定出的具体计划。项目开发计划应提前给管理部门,并作为开发阶段评审的基础。编写项目开发计划的目的是用文件的形式,把对于在开发过程中各项工作的负责人员、开发进度、所需经费预算、所需的软硬条件等问题做出的安排记载下来,以便根据本计划开展和检查项目的开发工作。

    软件需求说明书(产品人员)

    软件需求说明书也称为软件规格说明。该说明书对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议,也是实施开发工作的基础。软件需求说明书的编写目的就是为了使用户和软件开发者双方对该软件的初需求有一个共同的理解,并使之成为整个开发工作的基础。

    概要设计说明书 (开发人员)

    概要设计说明书又可称系统设计说明书,这里所说的系统是指程序系统。编写的目的是说明对程序系统的设计考虑,包括程序系统的基本处理。流程、程序系统的组织结构、模块划分、功能分配、接口设计。运行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。

    详细设计规格说明书(开发人员)

    详细设计说明书又可称程序设计说明书。编写目的是说明一个软件系统各个层次中的每一个程序(每人模块或子程序)的设计考虑。如果项目比较简单,层次较少,本文件可以不单独编写,有关内容合并入概要设计说明书。

    用户操作手册(产品人员)

    用户操作手册的编写是要使用非专门术语的语言,充分地描述该软件系统所具有的功能及基本的使用方法,提供该软件每一个运行的具体过程和有关知识,包括操作方法的细节。使用户(或潜在用户)通过本手册能够了解该软件的用途,并且能够确定在什么情况下,如何使用它。

    测试计划(测试人员)

    测试计划是软件项目实施计划中的一项重要的内容,应当在软件开发初期、即需求分析阶段制订。测试计划应当定义被测试对象和测试目标,确定测试阶段和测试周期的划分;制订测试人员、软硬件资源和测试进度等方面的计划,规定软件测试方法,测试标准以及支持环境和测试工具。针对子系统在特定的测试阶段所要进行的测试工作制订详细计划,它详细说明规定了测试小组的各项测试任务,测试策略、任务分配和进度安排等。

    测试分析报告(测试人员)

    测试工作完成以后,应当提交测试计划情况说明书,对测试结果加以分析,并提出测试的结论性意见。

    开发进度月报(开发人员)

    开发进度月报的编写目的是及时向有关部门汇报项目开发的进度和情况,以便及时发现和处理开发过程中出现的问题,一般,开发进度月报是以项目组单位每月编写的。如果被开发的软件系统规模比较大,整个工程项目被划分给若干个分项目驵承担,开发进度月报将以分项目为单位每月编写。

    项目开发总结报告(产品人员)

    软件项目开发完成之后,应当与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力。此外,还需对开发工作做出评价,总结经验和教训。项目开发总结报告的编写是为了总结本项目开发工作的经验,说明实际取得的开发结果以及对整个开发工作的各个方面的评价。

    软件维护手册(开发人员)

    主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护 过程的说明,便于软件的维护。

    软件问题报告(测试人员)

    指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软件修改提供准备文档。

    软件修改报告(开发人员)

    软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。

    总结

    根据项目的规模大小,以及人员构成,对所需要的文档进行编写,将大大提高项目开发的效率及规范程度。

    参考资料

    1. 软件开发相关文档刘米雪
    2. 软件开发文档总集Recode_的专栏
    3. 软件开发文档编写规范zhanghui962623727的博客
    展开全文
  • 文档型数据库

    万次阅读 2019-03-22 09:20:36
    文档型数据库 简介 1. MongoDB:文档型数据库,按照文档的形式存储 a. Web App(用的较多) 2. 数据库管理系统(DBMS) a. 需要把具体如何实现的如 增删改查 隐藏在系统软件中,对用户软件透明 基础概念: a. ...

    文档型数据库

    简介

    • MongoDB:文档型数据库,按照文档的形式存储
      • Web App(用的较多)
    • 数据库管理系统(DBMS)
      • 需要把具体如何实现的如 增删改查 隐藏在系统软件中,对用户软件透明

    基础概念:

    • 文档(数据模型) 【关系数据库的数据模型是表格】

      • 用<key/attribute,value>存放,json的格式
      • 一个文档里还可以包括子文档
      • 每个文档都有个_id,如果在一个文档中没有说_id是什么,数据库会自动分配一个,可以通过_id找到数据库的任何一个文档
      • 一个文档可以是做一个对象(json)
    • 文档集(collection)

      • 文档的集合(一个文档集可以视为一类对象)
    • 数据库(database)

      • 若干个文档集构成一个数据库
      • 部署在一个服务器上,【一般】一个数据库对应一个应用

    文档的访问接口

    • 插入文档

      • db.foo.insert({“bar”:“baz”})
        • db:datebase foo:collection
      • db.foo.batchinsert() 批量插入
    • 查找文档

      • db.blog.find() [查blog文档集的所有文档]
      • Joe=db.people.findOne({“name”:“joe”,“age”:20}); [查people文档集特定属性的文档]
      • db.users.find({},{“username”:1,“email”:1}) [只返回users文档的username,email这两个属性、前面的空括号表明不限定如何查询条件,如果这里去掉后面两个属性就变成查询条件了]
      • db.users.find({“age”:{“gte&quot;:18,&quot;gte&quot;:18,&quot;lte”:30}}) 【查年龄在18~30的用户文档】
      • db.raffle.find({“ticket_no”}:{"$in"} :{ [725,542,390]}})
    • 删除文档

      • db.foo.remove()
      • db.mailing.list.remove({“opt-out”:true})
    • 更新文档

      • db.users.update({"_id" : ObjectId(“28h32j223e92e”)},…{"KaTeX parse error: Expected 'EOF', got '}' at position 44: …War and Peace"}}̲) 【set指置换】
      • db.games.update({“game” : “pinball”, “user” : “joe”},…{"$inc" : {“score” : 50}})

    文档模型的设计思想

    • 优点:每个元素都被视为对象(储存为json格式)

    存储器件

    • 数据处理性能的宗旨
      • 提高数据访问的局部性:
        • 对磁盘/闪存而言
          • 减少I/O的次数;
          • 变随机访问为顺序访问。
        • 对内存而言
          • 增加Cache的命中率
    • 数据库的基本存储架构
      • 以页为单位存放数据。每一页为512bytes的整数倍,4KB到4MB。

    索引:

    • 对于非聚集索引,有些查询甚至可以不访问数据页。

    • 聚集索引可以避免数据插入操作集中于表的最后一个数据页。

      当然,众所周知,虽然索引可以提高查询速度,但是它们也会导致数据库系统更新数据的性能下降,因为大部分数据更新需要同时更新索引。

    参考 https://www.cnblogs.com/ccsccs/articles/4243644.html

    • B-Tree
      • B-Tree的平衡性

        • 每个节点的大小固定(e.g. 4KB或8KB),因此最多只能容纳n个键和n+1个指针。
      • 什么决定B-Tree的效率?

        • 树的高度决定查询需要I/O次数。
        • 对于同样规模的数据,n越大树的高度越低。
        • 为了提高B-Tree的效率,我们需要增加n,即增加每个节点容纳键和指针的数量。
          • 用简短的数据类型定义键的属性,e.g. smallint.
          • 对B-Tree进行压缩。
    展开全文
  • 文档下载器是百度文档下载器 使用很简单,把你在百度文库搜到的资料的网址复制到软件的相应地方然后点下载就OK了 有3缺陷: 1,下载的东西都会强制转化为pdf的格式, 2,还有就是有些系统会用不起这两个软件,特别是...
  • 从需求文档、API文档、部署文档到使用手册,多种定制文档编辑器,满足您整个开发周期需求; 支持接口在线测试,一键生成mock配置。 极致的编写体验,优雅的排版,让文档成为一种乐趣。 查看示例文档 查看使用...

    易文档 https://easydoc.top 让您轻松编写和维护高质量的文档。

    从需求文档、API文档、部署文档到使用手册,多种定制文档编辑器,满足您整个开发周期需求;

    支持接口在线测试,一键生成mock配置。

    极致的编写体验,优雅的排版,让文档成为一种乐趣。

    查看 示例文档 

    查看 使用技巧

    展开全文
  • 如何下载Java API文档

    千次阅读 2019-10-10 17:31:04
    Java开发过程中,我们经常需要查看Java API文档。 官方的Java API文档是在线的,如何下载下来呢? 方法如下: 1、打开Java文档下载地址 地址如下:...

    Java API是Java平台的重要组成部分。

    Java开发过程中,我们经常需要查看Java API文档。

    官方的Java API文档是在线的,如何下载下来呢?

    方法如下:

    1、打开Java文档下载地址

    地址如下:https://www.oracle.com/technetwork/java/javase/documentation/jdk8-doc-downloads-2133158.html

    2、接受许可协议

    如下图所示:

    3、下载jdk-8u221-docs-all.zip

    单击jdk-8u221-docs-all.zip,下载Java文档。

    注意:如果弹出登录框,请输入用户名和密码。如果没有用户名密码,请注册。

     

    展开全文
  • 软件开发文档-详细设计文档

    万次阅读 2019-06-21 11:22:34
    帮助开发人员理解项目的业务逻辑术语描述执行标准与相关文档 编码标准,文件管理标准,版本管理标准项目概述 1.背景 2.现状项目目标编码规范系统功能概述 系统功能总图系统总体介绍系统模块设计 模块结构图,...
  • 前端实现在线预览文档

    万次阅读 热门讨论 2019-06-03 17:22:07
    前端实现在线预览文档 最近项目开发中需要实现在线预览Word,Excel,PowerPoint格式的文档,网上查找了很多资源,各说纷纭,但是在一一尝试之后只有使用微软的预览接口才能成功,其他的会出现各种各样的问题,现在说下...
  • 40 行代码搞定主题词提取

    千次阅读 2019-07-05 10:16:29
    七月 上海 | 高性能计算之GPU CUDA培训7月27-29日三天密集式学习 快速带你入门阅读全文&gt;正文共1346个字,预计阅读时间8分钟。大家都知道,做中文搜...
  • 文本主题提取

    千次阅读 2018-01-13 16:58:32
    主题关键词:能够体现文本内容主题的关键词 一、TF-IDF模型 ...逆向文档频(IDF)= log(语料库中所有文档总数/(包含某词的文档数+1)) 注意 - 为了避免分母为0,所以在分母上加1 - 所指的词个数,一定
  • 软件开发技术文档编写规范

    万次阅读 多人点赞 2017-12-29 10:00:26
    在项目开发过程中,应该按要求编写好十三种文档文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。  ◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述...
  • OpenKM安装及详细配置-绝对实用

    千次阅读 热门讨论 2020-04-16 10:24:54
    作者:FCyunwei 参考文章:https://blog.csdn.net/li_cheng_liang/article/details/78899348 ... 前言 所谓万事开头难,初次接触OpenKM也是从百度查资料开始,但发现真正有价值的文章不多。 在windows平台参考C...
  • 正确规范写接口文档

    万次阅读 多人点赞 2018-05-17 14:14:27
    前言 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。下面我总结下自己看到的优秀接口文档。银联接口文档案例:5.2.2 统一收单线下交易查询...
  • Java Web项目中使用Freemarker生成Word文档

    万次阅读 多人点赞 2014-09-21 15:42:43
    Web项目中生成Word文档的操作屡见不鲜,基于Java的解决方案也是很多的,包括使用Jacob、Apache POI、Java2Word、iText等各种方式,其实在从Office 2003开始,就可以将Office文档转换成XML文件,这样只要将需要填入的...
  • 接口文档要如何写

    万次阅读 多人点赞 2015-04-21 14:36:13
    一个简单的接口文档,写完给组长看后,发现漏洞百出。下面总结一下写文档需要注意事项: 封皮 封面最好是本公司规定的封面,有logo,内容标题,版本号,公司名称,文档产生日期。(错误地方在于,文档的标题要和页眉...
  • 作为一个公司的技术部门,就会涉及到一些文档的对接,包括但不仅局限于 需求文档 会议记录 接口文档 切图标注 对接的部门,包括但不仅局限于 前端和后端 移动端和后端 设计和前端 设计和移动端 产品经理和开发...
  • java jdk 8 帮助文档 中文 文档 chm 谷歌翻译

    万次下载 热门讨论 2020-07-30 23:30:21
    JDK1.8 API 中文谷歌翻译版 java帮助文档 JDK API java 帮助文档 谷歌翻译 JDK1.8 API 中文 谷歌翻译版 java帮助文档 Java最新帮助文档 本帮助文档是使用谷歌翻译,非人工翻译。准确性不能保证,请与英文版配合使用 ...
  • 查看python的模块和函数帮助文档方法

    万次阅读 多人点赞 2017-02-17 13:46:51
    python的一个优势是有着大量自带和在线的模块(module)资源,可以提供丰富的功能,在使用这些模块的时候,如果每次都去网站找在线文档会过于耗费时间,结果也不一定准确。因此这里介绍下python自带的查看帮助功能,...
  • 如何编写一个项目开发文档

    万次阅读 多人点赞 2018-09-29 21:51:31
    不同公司会对文档做不同要求,划不同的分类,但一般来说(或者拿自己的经验说)大致可以分为需求文档、接口文档、流程图(可以单独作为一份文件可以作为附件附在文档中)、变更文件等。 一、需求文档 在项目启动...
  • 参与 Spring 4 中文文档翻译

    万次阅读 多人点赞 2017-08-13 17:37:49
    参与 Spring 4 中文文档翻译我们从2014年12月开始翻译Spring 4的框架文档,虽然至今已有一年,但是进度很慢。其中一部分原因是因为Spring 文档有1000多页,而且翻译的时候根据章节分配,导致许多人一次要翻译2000~...
1 2 3 4 5 ... 20
收藏数 3,206,359
精华内容 1,282,543
关键字:

文档