请多多指点—关于项目文档

问题描述

小弟刚刚接触软件开发,希望各位大哥不要见怪。求一个完整项目,从开始到结束都需要一些什么文档支持。

解决方案

解决方案二:
要有项目的需求分析,项目介绍

解决方案三:
这个么有
解决方案四:
需求分析文档。概要设计文档。数据库文档。如果设计的好的话,还有功能模块的API接口文档。(非必须)测试文档。最后,软件的安装手册。
解决方案五:
引用3楼achilles_dynasty的回复:

需求分析文档。概要设计文档。数据库文档。如果设计的好的话,还有功能模块的API接口文档。(非必须)测试文档。最后,软件的安装手册。

实际中还经常会有编程规范约定,针对不同类型的项目要求,可能会有些不同注意事项需要写在里面供所有成员遵循。而稍小些的项目,这些一般就直接分散在概要设计和数据库文档等文档内体现。

时间: 2024-11-10 01:06:48

请多多指点—关于项目文档的相关文章

android项目文档 ,需要整理准备哪些东西 它应该包括多少个部分,都写些什么呢

问题描述 android项目文档 ,需要整理准备哪些东西 它应该包括多少个部分,都写些什么呢 最近项目越来越大,都出现了65536的问题,由于之前好多人写的,没有系统的整理过,我最近想要写一个相关的东西,该从何入手,都包括哪些内容呢 解决方案 项目说明性文档,一般架构和实现两块.架构说说我准备盖一座什么样的房子,有几个门,几个窗等等,实现写写门是什么材料做的,用到了什么技术,实现了什么功能,如何实现的.类似的梳理过程,卤煮可参考参考. 程序文档自动生成就行了. 解决方案二: 什么相关的东西,网上

游戏设计-请推荐管理游戏物品设计文档的工具

问题描述 请推荐管理游戏物品设计文档的工具 请问各位大侠,有没有这样的工具: 我在设计游戏中的物品,想比较方便的管理物品的设计文档,这些文档需要被组织成继承树的结构,就像Android SDK的reference文档一样.例如以下物品 物品 非生命物品 人造物品 人造卫星 电源 核动力电源 星载核动力电源 计算机系统 星载计算机系统 容器物品 那么,期望的"人造卫星"的设计文档应该类似这样的 人造卫星 ??人造物品 ???非生命物品 ????物品 概述 人造卫星由星载计算机系统.电源及

急求软件〈〈要设计说明书》和《详细设计说明书》示例,是真正的项目文档,不是模板。

问题描述 急求软件〈〈要设计说明书>和<详细设计说明书>示例,是真正的项目文档,不是模板. 解决方案 解决方案二:晕,真正的东西都是公司的,谁敢给你原装的啊,能给你个模版就不错了,老兄.

求推荐项目文档管理系统,不是用于开发团队,而是用于最终归档文件管理的

问题描述 求推荐项目文档管理系统,不是用于开发团队,实现什么版本控制功能的.[而是用于最终归档文件管理的,除了基本的文件上传.下载.检索功能外,还要能够设定一个项目最终需要提交哪些类型的文档,方便的查看哪些项目文档已经提交完成,哪些项目还缺少规定的文档,可以生成缺少文件的具体报表等功能!如果能自动对提交的文档的内容进行校验(校验规定的内容是不是都已经有)就更好了!有这样的文档管理系统吗??求大神推荐!!感激不尽! 解决方案 本帖最后由 whitebird108 于 2014-09-30 21:4

软件标准项目文档

原文:http://www.cnblogs.com/Little-Li/archive/2011/06/30/2094230.html 在项目开发过程中,应该按要求编写好十三种文档,文档编制要求具有针对性.精确性.清晰性.完整性.灵活性.可追溯性. ◇ 可行性分析报告:说明该软件开发项目的实现在技术上.经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由. ◇ 项目开发计划:为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员

开源项目文档13处应规避

大多数开源项目开发者只关注于软件的质量,而常常忘记编写高品质的文档.但是,文档的好坏对于一个项目的成功有着至关重要的作用,它可以帮助用户快速了解这个项目,或在用户的使用过程中提供一些帮助.  然而,有很多开源项目的文档令人失望,主要表现在以下几个方面.  1.  缺乏一个良好的README或介绍  README可以使潜在用户对你的项目有一个初步.快速的了解,如果该项目在GitHub上,README文件会自动显示在该项目的主页.如果你想一下子吸引住用户,并让他们继续探索你的项目,那么一个好的介绍必

10 个项目文档最佳实践

在软件开发和维护过程中,文档是必不可少的资料,它可以提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导.帮助.解惑的作用.尤其在维护工作中,文档的重要性更是不言而喻.  本文整理了软件开发中10个最佳的文档编写实践,希望能对你的工作有所帮助.  1.  将编写文档作为开发工作中的一个重要环节(例如,占用总开发时间的10%).在软件开发中,不能没有文档,但如果编写文档占用了大部分的时间也不合适.可以根据需要制定代码文档.需求说明文档.设计文档.测试文档.用户手册等,在制定完成后,可以

使用 Github Pages 发布你的项目文档

你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程.近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录. 文档的质量是一个软件项目健康发展的标志.对于开源项目来说,维护一个可靠而不出错的知识库.详细说明所有的细节是至关重要的.精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程. 在

Git与GitHub学习笔记(六)使用 Github Pages 管理项目文档

前言 你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程.近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录. 文档的质量是一个软件项目健康发展的标志.对于开源项目来说,维护一个可靠而不出错的知识库.详细说明所有的细节是至关重要的.精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程