精华内容
下载资源
问答
  • 项目文档的重要性

    千次阅读 2019-10-15 22:38:50
    在项目日常工作中,对于文档常常听到有人讲“没空,没时间写文档”,“写文档太浪费时间了”,“项目文档没必要”,甚至“写文档好了,其他什么事都不用做了”这样的话,这种情况常发生在不少项目管理者和开发技术...

    在项目实施的过程中,我们会有各方面的工作,会遇到各种问题。很多时候我们都需要写文档帮助我们。在项目日常工作中,对于文档常常听到有人讲“没空,没时间写文档”,“写文档太浪费时间了”,“项目文档没必要”,甚至“写文档好了,其他什么事都不用做了”这样的话,这种情况常发生在不少项目管理者和开发技术人员身上。这种想法要不得,如果不改正,是潜在的风险,后期会对项目带来严重不良影响。
    在开展项目活动,解决项目问题的过程中,项目文档工作非常重要,是项目管理者的好帮手,也是项目高质量的保障。可以说“无文档,不项目”。为什么这么说呢?项目文档的重要性体现在以下几个方面:

    一、 工作开展的前提
    口说无凭,立字为据。文档体现了一种态度-严谨。文档将内容清楚、完整的表述,避免歧义或将歧义降到最低,按文档执行综合成本最低。项目的计划、需求、设计、开发、测试、上线运维等环节都需要文档支撑。如果说项目制度规范是人体骨骼,那么项目的文档就像身体的血液,是人体不可或缺的重要组成部分。

    在参与人数很少的项目中,口述情况较多,文档的作用并不明显,因此往往会被忽视。好比开一家餐馆可能只要1-2个手艺高超的厨师就可以了,口口相传可以保持菜品的特色,不需要纸面上的文字或工艺说明。但像麦当劳、喜茶一样,在全国、甚至全球范围内开设大量出品一样味道的分店就必须要有严格的工艺标准,甚至对设备标准都有明确的文件规定。
    有人说写文档是浪费时间。可往往这样,因为工作内容或标准的不确定,后期反复修改、需求不断变更增加的时间、人力成本更多,常常是得不偿失。

    二、 文档是项目管理和监控的重要工具
    文档是管理者跟踪和控制项目的一个重要工具。管理都跟踪和控制项目主要通过面对面的交流与文档两种方式,交流具有随机性、即时性与局限性的特点,而文档具有延续性、长期性与全面性的特点,特别是报告与进度文档能让管理者对项目的整体情况有全面了解。
    监控需要对比的基础。文档作为成果检查的重要标准之一。系统设计是否合格,需要看是否满足用户需求的功能或指标。开发是否合格要检查是否满足设计要求。

    三、 项目制度规范的承载
    工作规范包括各种制度、规定、要求等,这些内容都通过文档的形式表达和传递。无论人员如何变更,时间如何推移,这些文档不会消失,只会更加详尽、合理和完善。

    四、 工作成果的体现
    文档是工作成果的重要表现形式。项目每个阶段都需要输出成果。比如需求调研、系统设计、系统测试等阶段结束,都需要提供相应的成果文档。完成了重要方案或变更的讨论,需要文档如实、完整的记录过程和结果。几乎所有人类的智慧和文明成果都通过书面文字表达和传承。几千年前古人的思想精华,仍然可通过《论语》《孙子兵法》等进行了解和汲取。
    工作成果也是项目阶段转换的必要条件。项目工作随着时间推移包含了多个阶段,每个阶段的输出是下一个阶段的输入。上阶段的成果输出,影响下阶段过程和产出。需求阶段的成果标志着设计阶段的开始,设计阶段的输出标志者开发阶段的启动。由此可见,项目的运作在一定程度上是靠文档驱动的。
    另外,,用户的签字在阶段成果确认方面有重要的意义。

    五、 便于项目成员间的交流和协作
    文档是项目管理者跟踪和控制项目的一个重要工具。管理者跟踪和控制项目主要通过面对面的交流与文档两种方式,交流具有随机性、即时性与局限性的特点,而文档具有延续性、长期性与全面性的特点,特别是报告与进度文档能让管理者对项目的具体情况有全面和真实的了解。

    六、 项目共享知识库
    项目文档不断累计,形成知识库,不仅可项目内部共享,还可以在项目组之间和公司内部分享,文档的充分利用能使知识发挥更大的效益。充分的知识共享是提高整体团队效能必不可少的工具。比如,复杂的数据库集群,配置过程非常繁琐,要求细致。单靠在网上的指引,没有经过用户实际环境的检验,操作效果是大大折扣的。有时,遇到问题长时间都不能解决。而具体的实践总结能给人清晰的指引,极大的提高效率。同时,也要培养相应技术储备人员,降低未来可能的风险。

    七、 项目文档有助于管理者水平的提升
    项目文档对于项目管理人员的素质提升也是大有裨益的。目前国内不少企业在进行项目管理时,都会出现一个通病:由于管理人员素质有限,许多的决定只凭口头叙述,缺少足够的文字记录,以至在项目出现问题时往往显得无所适从。从本质上讲,项目文档强调的是一种规范化管理,要求项目管理人员利用书面语言进行沟通表达,以指引项目运作,对于一个成功的项目管理人士来说,他不仅仅是项目各利益方的良好协调者,更应该是一名出色的项目文档管理者。

    综上所述,文档的重要性无需质疑。那么,如何编写好的文档呢。通常对项目文档的要求有以下几点:

    1. 清晰明了。有目标明确,思路清晰,文字详尽,配以图表、截图和示意图,方便阅读者理解。
    2. 全面深入分析的成果。文档是作者经过深入分析、思考、总结的结果,是经验的总结、实践的硕果、思想的升华。
    3. 及时。根据项目进展情况及时提供的成果文档,能成为照亮黑暗的灯塔,探险者的指南针,渡河者的小船。
      不管项目情况如何复杂,用户给的压力如何大,工期如何紧张,我们都要意识到写文档的重要性和必要性,并养成编写好文档的习惯。

    朱玉顺
    2019年10月15日

    展开全文
  • 大数据组项目文档整理方案

    千次阅读 2017-02-09 09:04:47
    一、 项目文档规范说明 1. 文档结构说明 2. 案例说明 二、 项目文档结构说明 1. 文档结构步鄹: 2. 案例如下: ——————————————————————————————————— 一、 ...

    目录:

    一、 项目文档规范说明

    1. 文档结构说明

    2. 案例说明

    二、 项目文档结构说明

    1. 文档结构步鄹:

    2. 案例如下:

    ———————————————————————————————————

    一、 项目文档规范说明

    1. 文档结构说明

    1) 流程图使用Visio画图
    2) 其余资料使用MarkDown:只能有大标题、小标题和表格

    2. 案例说明

    1) MarkDown:大标题、小标题案例
    这里写图片描述

    2) MarkDown:表格案例
    这里写图片描述

    二、 项目文档结构说明

    1. 文档结构步鄹:

    1) 所有资料放在docs文件下面;
    2) Docs下面的按照模块划分,比如:loyality、user_group_portrait、web_nginx;
    3) 每个模块中只能包括:XXX业务流程图.vsdx,XXX业务流程及代码说明.md ,XXX业务维护说明.md

    2. 案例如下:

    1) Doc下面的按照模块划分
    这里写图片描述
    2) XXX业务流程图.vsdx,详细说明业务的执行步鄹
    这里写图片描述
    3) XXX业务流程及代码说明.md。其中包括:模块说明、 模块业务步鄹、模块代码说明、模块代码路径。(备注:标题一定要有,内容没有可以写“无”)

    这里写图片描述
    4) XXX业务维护说明.md,包括:建表语句、启动脚本路径及说明、Jar包路径、部署方式、更新方式、关闭方式、指标查询sql**(备注:标题一定要有,内容没有可以写“无”)**
    这里写图片描述

    展开全文
  • 项目文档管理

    2009-07-31 11:53:00
    项目文档管理(Project Documents Management)目录[隐藏]1 项目文档管理的概述2 文档管理在项目进程中的重要作用3 如何建立项目文档管理规定4 参考文献 if (window.showTocToggle) { var tocSho
     
    

    项目文档管理(Project Documents Management)

    目录

    [隐藏 ]

    <script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "显示"; var tocHideText = "隐藏"; showTocToggle(); } </script>

    项目文档管理的概述

      项目文档管理,是指在一个系统(软件)项目开发进程中将提交的文档进行收集管理的过程。通常,文档管理在项目开发中不是很受重视,当发现其重要 性时,往往为时已晚。整个项目可能因此变得管理}昆乱,问题产生后无据可查。文档管理对于一个项目的顺利进行有着至关重要的作用,其关键性不容忽视。

      项目文档管理涉及范围广泛,其内容会根据项目 的不同而有所变化。这里将重点讨论金融计算机软件开发项目中的文档管理。

      首先要了解文档管理的行业标准 。目前ISO 认证的企业通用管理规范 为软件系统开发提供了通用的管理规定和行业标准,它涉及文档管理的整个生命周期。细分文档的生命周期,一般包括:创建、审批、发布、修改、分发、签收、追缴、归档、废止与恢复这样几个环节。那么当企业需要按照ISO建立标准的文档管理规范时,将从何入手昵?

      对此,首先要将文档分为普通纸质文档和电子文档两类来讨论。通常情况,在一个项目中都会确定专门或兼职 的项目文档管理员。对于纸质文档,文档管理员只需要关心如何将其较好地分类归档并保存,而之前的各个环节则要由整个项目组共同把握。

      就目前业界项目的开发情况来看,电子文档使用较纸质文档更为方便、灵活、广泛。对于电子文档,我们大可不必头疼如何管理其整个生命周 期。VSS(Visual Source Safe)作为一种电子文档管理工具给我们提供了完整的文档管理功能,它覆盖了文档管理全生命周期各环节的管理要求。VSS通过客户端/服务器(C/S) 架构收集整个项目组成员的各类文档,通过管理员合理规划管理,将电子文档按目录保存并同时提供给整个项目组的不同成员使用。因此对于文档管理,重要的是如 何规划并制定出一套适合于自身项目的文档管理规则。

    文档管理在项目进程中的重要作用

      作为管理完善的项目文档,管理者完全可以依顺它的轨迹看清整个项目进展的脉络,同时通过对阶段性文档的把握使整个项目质量得到很好的掌控。制定一套完整有序的项目文档管理规定十分必要,其作用有以下6个方面。

      其一,它是项目管理者了解开发进度、存在的问题和预期目标的管理依据。第二,大多数软件开发项目会被划分成若干个任务,并由不同的组去 完成。文档管理则是不同小组任务之间联系的重要凭证。第三,可提供完整的文档,保证了项目开发的质量。第四,项目文档是系统管理员、操作员、用户、管理者 和其他相关人员了解系统如何工作的培训与参考资料;第五,项目文档将为系统维护人员提供维护支持;第六,项目文档作为重要的历史档案将成为新项目的开发资 源。

      现在大多数金融、通信企业为了更好的服务客户、准确掌握自身数据,都在不遗余力地建立数据仓库系统。企业数据仓库(EDW)从筹建项 目组到软件开发建设再到系统上线维护,基本涉及了软件项目建设的所有环节,对文档管理提出了比较全面的要求。以下就EDW建设为例做作进一步探讨。

      首先要借助VSS软件建立项目文档管理服务器以保存所有的项目文档。其次,项目保存的文档要涵盖项目管理 、 项目调研、项目开发、项目应用、系统管理、系统测试验收、项目培训、版本控制、数据质量管理、用户手册、系统上线等整个项目周期。然而从项目管理者的亲身 体会来讲,这些文档的保存往往是混乱无序,无法快捷地获得所需信息。究其原因,项目组在系统开发过程中虽然重视了文档的保存,但却忽视了文档的管理。文档 归档没有正式的管理要求,缺少文档提交的依据和规则。最后是建立文档管理规定。

      以EDW项目为例,未建立文档管理的情况如图1所示。由于没有统一的文档管理规定,项目小组 只对自己负责的项目文档熟悉。此外,无论是项目小组成员还是项目经理 都对自己需要的其他文档的保存地点、文档名称等信息缺乏了解,无法及时获取重要文档。因此,项目经理根本无法从项目文档把握项目进展情况。

    Image:项目文档管理1.jpg Image:项目文档管理2.jpg

      制定了文档管理规定后的情况如图2所示。由于项目文档管理员按照规定对文档进行管理,因此项目经理及小组成员都能快速得到自己所需的各类文档。同时,项目经理 还可以很清晰地透过项目文档把握项目进展情况。

    如何建立项目文档管理规定

      从各行业以及每个项目的个性出发,需要管理者结合实际情况制订出适合自身的文档管理规定。(软件文档管理指南》和《计算机软件产品开发文件编制 指南 (以下统称《指南》)为我们提供了相关的指导。首先要明确关于软件项目文档的具体分类。《指南 中提出文档从重要性和质量要求方面可以分为非正式文档和正式文档;从项目周期角度可分为开发文档、产品文档、管理文档;更细致一点还可分为l4类文档文 件,具体有:可行性研究报告 、项目开发计划、软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、数据库设计说明书、用户手册、操作手册、模块开发卷宗、测试计划、测试分析报告、开发进度月报、项目开发总结报告。这样的分类细化了项目进度中各个阶段所需管理的文档。

      其次需要将项目文档进行归类整理。下面对EDW项目组文档情况与 软件文档管理指南 进行对比分析 (见表1)。通过对比可以看出,没有规范管理的EDW项目组文档存在以下4方面的问题。

      问题1:项目组在开发初期针对业务部门和科技部门进行了需求及信息调研 ,可以覆盖部分软件需求和数据需求说明书的内容,但却缺少业务部门对项目需求 描述和变更的文档记录。这部分文档需建立相应目录予以保存。

      问题2:对于设计说明,在系统比较复杂的情况下,设计阶段应分解成概要设计和详细设计两个步骤。目前EDW项目组只对ETL模块提供了 概要设计说明书,并没有单独的存放目录,而是同其他设计文档混乱地放在一起。对于比较复杂的应用开发项目,应将这两种设计说明文档分目录管理。

      问题3:在项目测试验收中,项目组没有要求将测试计划文档和测试结果报告进行规档,而只重视了测试过程中的问题文档,因此无法掌控测试进度与质量。

      问题4:EDW项目组的工作分为模型设计、ETL、集市应用3个工作小组,对应的文档管理需要围绕这3个主题进行。其中模型设计和ETL都是数据仓库项目实施的模块,而集市应用则包括了建立在数据仓库 基础上的小项目开发。因此,文档管理也应该针对这3个部分不同的性质制定管理规则。

    Image:项目文档管理3.jpg Image:项目文档管理4.jpg

      通过表l中的对比分析,针对EDW文档管理存在的问题,EDW项目组最终依据通用规则建立了正式的项目文档管理规定。具体规定有以下5点。

      (1)将文档分为两大部分提交管理:项目常规文档和项目归档文档。常规文档的提交和使用根据项目组内部小组成员任务的不同进行权限划分;项目归档文档由项目管理主管(或项目文档管理员)将项目中的重要文档从常规文档中进行分类归档。

      (2)常规文档管理目录分为项目日常管理文档和项目流程管理文档。

      (3)日常管理文档包括项目报告、会议纪要、项目管理模板、重大问题跟踪、数据质量管理。项目报告又可分为个人周报、小组周报、项目周报、项目简报,项目简报。并都按照不同目录进行分类管理。

      (4)提交完整的项目开发、应用开发流程文档。一般包括:项目计划 、业务需求说明书、数据需求说明书、模块、应用开发文档、系统测试文档、详细设计文档、系统测试文档、用户手册、上线文档、培训资料、系统运行维护等。

      (5)所有项目组成员均建立VSS软件环境下的对应用户,各自拥有对以上各类文档的读、写、增加、删除权限。由各项目小组长保证提交已保存文档的质量;由文档管理员或项目经理整体把握项目文档在各阶段的提交情况(见表2)。

      项目文档管理规范制定好之后,关键在于大家要“依规执行”,使杂乱无章的存放模式变得井井有条。

    展开全文
  • linux平台使用doxygen生成项目文档

    千次阅读 2018-11-02 10:29:34
    目录linux平台使用Doxygen生成项目文档Doxygen简介安装Doxygen自定义Doxygen项目配置使用Doxygen命令生成配置模板文件配置Doxygen模板文件生成Doxygen项目文档代码注释规范生成html文档为html文档增加索引文件 ...

    Doxygen简介

    Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。
    更多详细内容请查看 Doxygen官网

    安装Doxygen

    本篇只介绍linux平台的使用方法,Doxygen同样支持Window和MacOS系统。
    安装方式:

    • 直接命令行安装
      sudo apt-get install doxygen
      sudo apt-get install graphviz

    • 下载Doxygen开源版本安装包,自行解压安装
      Doxygen开源版本

    自定义Doxygen项目配置

    使用Doxygen命令生成配置模板文件

    doxygen -g doc.dot

    根据工程的目录树来配置doc.dot文件,参考目录树如下:

    $ tree
    .
    ├── doc.dot
    ├── include
    │   └── dev_sdk.h
    ├── logo.png
    ├── Readme.html
    ├── README.md
    └── reference
    

    include目录存放代码头文件,reference目录用来存放生成的html文件。

    配置Doxygen模板文件

    只需要修改基本的字段,即可完成配置

    # 项目名称,显示在html首页
    PROJECT_NAME           = "Device SDK APIs"
    
    # 项目版本号,显示在html首页
    PROJECT_NUMBER         = "ver: 2.3.0"
    
    # 项目logo图片,显示在html首页
    PROJECT_LOGO           = logo.png
    
    # 输出目录,用来存放导出的html和配置文件
    OUTPUT_DIRECTORY       = reference
    
    # 代码使用的语言,这里使用c语言
    OPTIMIZE_OUTPUT_FOR_C  = YES
    
    # 导入的代码路径,多个路径使用空格隔开
    INPUT                  = ./include
    
    # 文件类型,如 *.c  *.cpp *.h
    FILE_PATTERNS          = *.h
    
    # 是否依次查找子路径
    RECURSIVE              = YES
    
    # 是否生成Latex,这样不使用latex,只需要html
    GENERATE_LATEX         = NO
    

    更多高级用法,请参考doc.dot注释自行研究。

    生成Doxygen项目文档

    代码注释规范

    Doxygen支持多种代码规范,这里举例一种常用规范

    /**
     * sdk information
    **/
    struct dev_sdk_info {
        char *device_id; /**< device id */
        char *device_key; /**< device key */
        int device_type; /**< device type */
    };
    
    /**
     * @fn          int dev_sdk_set_volume(int volume)
     * @brief       set device volume
     *
     * @param       [in] volume - input volume value
     * @return      On success, return 0. On error, return error code.
    **/
    extern int dev_sdk_set_volume(int volume);
    

    生成html文档

    修改好doc.dot配置文件后,使用命令生成html文档:
    doxygen doc.dot
    执行成功后,再reference目录下会自动生成html配置文件,打开reference/index.html文件即可查看。

    为html文档增加索引文件

    方便工程的整体性功能,可以在项目主目录增加Readme.html索引文件,将链接指向reference/index.html,如下示例:

    <!DOCTYPE html>
    <html>
    <head>
    	<title>Readme.html</title>
    	<style>
        	body {
            	width: 35em;
            	margin: 0 auto;
            	font-family: Tahoma, Verdana, Arial, sans-serif;
        	}
    	</style>
    </head>
    <body>
    	<h1>Device SDK API manual</h1>
    	<p><a href="reference/html/index.html">API reference guide</a> (./reference/html/index.html) </p>
    </body>
    </html>
    

    详细的代码和配置请参考 github工程 doxygen-template

    打开效果:
    索引

    文档

    展开全文
  • 项目文档编写及工具

    千次阅读 2018-09-06 15:04:33
    今天在阅读wireshark开源项目的时候,意外发现项目文档的组织结构非常方便,记录一下。  项目地址:https://www.wireshark.org/docs/wsdg_html_chunked/index.html  wireshark开发者指南中提到了一些有用,便捷...
  • 模型文档编辑器(生成项目文档)
  • 电商项目文档

    千次阅读 2018-09-12 18:03:18
    电商项目 1.包含主流电商业务逻辑的移动端项目 2.学习的主要目标是掌握移动端应用开发 项目准备 项目介绍 网站是中国主要的运动鞋、皮鞋网络零售网站,聚焦在垂直的鞋及其相关商品领域深耕。 凭借雄厚...
  • 从项目交接看项目文档管理

    千次阅读 2010-02-21 11:15:00
    FORM:北京华泰科信公司http://www.huataiinfo.com/PMCenter/PMWH431.htm 项目文档对于项目管理的作用已经不用再讲了,但文档的管理却又通常是项目管理中最容易忽略的内容。实际对于任何一个项目而言,文档一定要有...
  • 软件项目文档分类

    千次阅读 2019-04-18 11:08:26
    开发文档 开发人员前一阶段的工作成果,同时又是后裔阶段的工作依据 可行性研究包括 软件项目开发计划 软件需求规格说明 系统规格说明 软件功能说明书 数据字典 数据要求说明书 概要设计说明书 详细设计说明书 ...
  • MkDocs项目文档生成器(二)

    千次阅读 2016-09-02 22:26:56
    项目信息 内容介绍:MkDocs项目文档生成器(二) 博客地址:http://blog.csdn.net/kevindgk 版权声明:本文为原创文章,未经允许不得转载 联系方式:815852777@qq.com 我的GH Pages:...
  • 利用xcode自动生成项目文档

    千次阅读 2012-10-18 18:30:27
    在写代码的时候,如果按照一定的规范在头文件里写上注释的话, ...我们来看看如何利用Xcode生成项目文档。 步骤: 1. 在XCode里点击Project,然后点Add Target给项目添加一个TARGET 2. 在添加Target的弹出
  • 如何写项目文档项目文档有哪些?

    万次阅读 多人点赞 2011-06-30 11:39:00
    软件新人经常问我一个项目应该到底有哪些文档,在此结合工作实际把我一般形成的文档作一列表,仅供诸位参考。 一、项目立项建议书 项目立项建议书主要用于分析项目要求与各种资源是否能够匹配,用来决策层决定是否...
  • 关于项目文档和wiki页面

    千次阅读 2013-04-05 10:08:32
    最近为项目忙得焦头烂额,根本没时间维护先前写的项目文档和wiki页面。放假了,利用空闲时间重新审视了一下那些文档,有以下发现: 先前写文档的自己和现在忙的焦头烂额的自己,判若两人。它写得未必多专业,但...
  • 项目经理成长之路---PMP、管理知识、项目文档、项目管理软件工具、PPT、WORD 【1】PMP备考资料 | PMP备考九阴真经 --- 项目管理十大知识领域49个过程输入输出、工具与技术暨知识点汇总 ITTO 思维导图 (PMBOK®第...
  • MkDocs项目文档生成器(一)

    万次阅读 2016-08-31 20:38:24
    简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 ...简介类别:项目文档生成器,生成静态站点,管理MarkD
  • showDoc项目文档管理工具

    千次阅读 2019-03-31 14:20:31
    每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要...
  • JAVA项目文档模板

    千次下载 热门讨论 2008-02-20 11:24:12
    包括整个项目所有的文档模板内容,好东东,自己下下来看就知道了。
  • QMIS项目文档管理系统发布

    千次阅读 热门讨论 2012-04-15 17:17:21
    QMIS项目文档管理系统是一个准开源的系统(之所以称之为准开源,是因为在系统中使用到了一个收费的Office中间件SOAOffice,用于实现文档的在线编辑,在此也希望大家能提供一款开源的Office中间件以替代SOAOffice,...
  • ·内建族和构建族允许编辑和创建自定义的模型、类型和参数,区别是内建族只能存储在当前的项目文档里,不能被其他文档使用。 编辑族(EditFamily)和载入族(LoadFamily)的方法: 在当前文档中,如果加载了一些构建...
  • JAVA:项目文档及编写目的汇总

    万次阅读 2018-12-05 10:04:58
    文档是农产品电商后台管理系统的指导性文档,该文档确定并描述为完成项目目标所需的各项任务(活动)范围,确定负责制性项目各项任务的全部人员,制定各项任务的时间进度表,阐明每项任务所需的人力、物力、财力,...
  • 软件项目文档及其必要性

    千次阅读 2017-02-21 18:07:03
    不论项目的规模如何小,项目经理聪明的做法都是:立刻正式生成若干文档作为自己的数据基础,哪怕这些迷你文档非常简单。接着,他会和其他管理人员一样要求各种文档。 做什么:目标。定义了待完成的目标、迫切...
  • 部署springboot+vue项目文档(若依ruoyi项目部署步骤)

    万次阅读 热门讨论 2020-02-20 21:22:01
    部署springboot+vue项目文档(若依ruoyi项目部署步骤) 一:部署linux + nginx 二:部署windows + tomcat(无nginx) 三:解决调用第三方api如百度地图api所存在的跨域问题 最近部署若依项目,一直部署失败,多亏有...
  • 市面上也有越来越多的工具来辅助我们完成团队协作,但是很多工具都比较偏向重量级别,且闭源收费,那么今天,我想为各位介绍一款开源免费且功能强大,支持线下部署,融合了文档和接口管理的轻量级协作工具DOClever ...
  • 使用phpdocumentor2生成项目文档

    千次阅读 2015-11-15 16:42:50
    项目文件往往会越来越多,这时如果我们寻找一个类文件,想知道他的功能时,可能需要到一个很深的目录结构中去寻找,而且我们很多时候并不是想研究这个类文件的代码,而是想看看这个文件的作用和类文件中包含了哪些...
  • 在上一篇文章【VS+Qt项目开发】(二)在VS2015中创建Qt项目中我们创建...我们现在的文档结构是这样的——最左边的是我们解决方案的整体文件夹,中间是我们Qt项目的文件夹列表,最右边的MySolution项目的内部文件夹以...
  • 如何更好的进行项目文档管理 在文档管理的过程中,需要把握住一些重要的原则和方法,这样可以让我们的文档真正达到我们预期的目的。 文档模板的管理 面对各类纷繁复杂的文档,如果各式各样,每个人一个风格,不论...
  • 如果你的eclipse怎么改都改不了... - 选择菜单栏Window,再点击preferences,在弹出框的general下的Content Types,展开text项,下面有很多种文档 比如java文档,点击Java Source File,如果下面有编码设置,说...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 143,620
精华内容 57,448
关键字:

项目文档