精华内容
下载资源
问答
  • 教你怎么写开发文档

    热门讨论 2007-10-24 13:30:37
    教你怎么写开发文档,很详细的哦.
  • PHP 开发技术文档

    2010-06-08 16:18:22
    PHP 5开发技术文档 PHP 5开发技术文档 PHP 5开发技术文档
  • 在项目开发过程中,应该按要求编写的开发文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。
  • 如何出受技术欢迎的需求文档

    千次阅读 2018-10-31 14:49:01
    综述 正如我们做出来的产品都希望受用户欢迎,开发和测试是需求文档的用户,产品...虽然不可能得像开发人员设计文档的一样专业,但产品经理如果能运用技术人员的思维多做些考虑,就能减少评审过程的反复沟通,...

    综述

    正如我们做出来的产品都希望受用户欢迎,开发和测试是需求文档的用户,产品经理也应该重视他们的想法和要求才能写得令人满意。

    “写需求文档”说专业点是把用户(或运营、客服等)的需求转化成技术部门的话语,因此了解技术术语是产品经理的基本素质。要做到需求文档受欢迎,了解术语是不够的。虽然不可能写得像开发人员写设计文档的一样专业,但产品经理如果能运用技术人员的思维多做些考虑,就能减少评审过程的反复沟通,那必然能收到大量好评。

    技术人员的思维同样是被工作环境和内容训练形成的,编程语言、架构设计、测试方法是最主要的因素。其中,开发人员会有这些思维:

    1. 组件与模块。
    2. 流程与联系。
    3. 条件与时机。
    4. 类型与精度。

    测试也会有独特的思维:

    1. 极端。
    2. 因果。
    3. 场景:一系列的组合条件。

    另外,用户体验思维中的“层次分明、重点突出”,也非常有助于优化需求文档的视觉效果以提高阅读效率。

    我们以每种思维作为章节来回答本文的问题。

    开发思维:组件与模块

    我们写文章都不是从头到尾就一段话的,会分段落、章节,这样能帮助做到条理清晰。代码的本质也是“文章”,组件和模块就像是段落和章节,他们会对应一个功能、界面或规则。为此,需求本身也应有拆分:产品有结构,功能有细分,界面分区块等。

    产品结构图就像文章的目录,在做新项目的时候应该附上。它不仅帮助产品经理自己梳理子需求,也让整个项目组都清晰知道产品的构成,对开发、测试、UI设计师后续的工作都有指导作用。现在多数人会用思维导图来画,原因就是它的最大作用是理顺思路。

    功能细分可以用“评论”功能来举例,它可分为:

    • 前置的登录注册等条件
    • 界面上评论区的功能(比如@他人,回复某楼层,引用回复,表情输入等)
    • 提交前的限制条件校验(比如字数、特殊字符)
    • 提交评论的过程
    • 评论的内容检验(比如涉黄、敏感信息)
    • 评论后的展示(比如引用回复、互相@)
    • 用户信息里的评论信息更新

    如何做需求拆解是没有固定模式的,跟业务有紧密关系,一般的两个思路是流程和规则。

    下图是界面分区块的示例(示例的意思是在原型和文档上这样命名,这不是原型图)
    分区块

    分区块并进行命名的好处:

    • 利于文档描述,减少说明字数,加速阅读
    • 利于沟通。大家只要说一个名字,就知道是说哪个部分,不用对着界面说。如果整个产品每个区域的名字是唯一的,那么报bug的时候可能连操作路径和截图都不需要了。
    • 一般来说,开发写代码时也会用这些命名的(翻译成英语),他们会很感激产品经理帮他们想好了名字。

    开发思维:流程与联系

    需求是一个整体,拆分后的各部分必然仍有联系,他们的协作步骤即是流程。产品的交互设计在代码流程上是大致对应的,所以如果产品经理能把流程描述详尽的话,开发的工作差不多等于把这堆“中文”用编程语言翻译一遍而已。

    如果流程足够复杂,就需要用图来表达。画图是描述复杂事物的基本技巧,不仅仅是需求文档的写作要求了,这里不展开讲。那么怎么才算复杂呢?一般简单的判断是:以最长的步骤路径为基准,如果超过30%的步骤有分支就应该画流程图。例如如果有7个步骤,有3个步骤是“是非选择”或“循环指向”,那就该画;只有2个步骤有分支就不用画,用文字说明白。延伸地讲,如果分支太多,需求本身可能就有问题了,应该从交互设计上去简化它,不应该给用户这么多可选择的东西而造成困扰。

    一个实际的文字描述步骤例子:

    1. 进入“我”页面
    2. 是否已登录,是则继续,否则进入“登录”流程
    3. 点击“评论”区,进入评论页
    4. 如果评论数为空,显示占位图,否则显示评论列表
    5. 点击评论列表中的一条,进入帖子详情页,并且页面自动滚动到那条评论的位置
    6. 用户点右上角的“关闭”,跳回第4步,否则按“帖子详情页”的流程继续

    在上面的例子里,我们也看到,流程之间会产生联系。一个流程中的某些步骤可以关联到另一个流程。这些流程之间的联系,在开发设计中会体现为“模块间的依赖或调用关系”。作为产品经理无需理解前面双引号内词语的技术意义,但有一个很典型的场景能帮助大家认识它的作用:开发解决了一个bug后导致了别的bug;更经典的是,开发抱怨说这是因为产品的新需求没考虑到对原有功能的影响。

    无论最终是否开发的责任,产品经理也应该去梳理各个需求之间的联系,包括界面、交互、功能的相互影响。最好是文档中有独立的章节列出需求间的关联。这不仅是帮助开发测试做好设计,也是为自己检查疏漏。拿一个普遍的需求“登录”来举例,产品经理应该列一下所有“不登录就不能访问的页面”。以后改动登录功能的时候,自己也可以一下子看清所有的影响范围。这个习惯最能防止“状态多层次级联”(如A影响B,B影响C)的情况下考虑不周。

    开发思维:条件与时机

    计算机是不会执行没描述过的操作的,即使是火热的人工智能,也是要经过训练才知道什么条件做什么操作。所以开发需要在代码中精确描述:

    1. 流程的入口场景,即这种“可能性”的触发时机。
    2. 流程内每个步骤的执行条件。

    不同的条件会导致不同的结果,这对用户使用有重大影响,所以一定把所有的条件和可能性都列出来。一般来说,产品经理最大的疏漏是没考虑异常情况。其实无论过程怎样,最终反映在界面上只有4种结果:

    1. 加载中
    2. 数据正常,正常显示
    3. 无数据,数据为空
    4. 出错,包括超时

    产品经理把这4种结果的界面都定义清楚,就能覆盖所有中间过程的情况。当然,最好还是能把中间过程的可能性都考虑周全,并针对不同的状况有更精细化的结果展示。

    开发思维:类型与精度

    这是编程语言(更确切来说是CPU计算原理)带来的思维。我们不去深究计算机知识,只需知道对我们的影响:要用数据来描述一个事物以便计算机能理解。这些数据分两大类型:数字与文本。其中文本要考虑长度,数字还有这些考虑:

    • 整数还是浮点数,即是否带有小数部分
    • 浮点数保留多少位小数部分
    • 是否可能是负数
    • 最大绝对值是多少(数字越大,可能会需要更多内存和计算时间。做适当限制有利于提高性能)

    这个思维(或者说限制)会影响所有需要用户输入交互的地方。如果原型图上不能明显看出以上的信息,产品经理应该有意识地在文档中补充。

    测试思维:极端

    极端的情况下容易出bug,这是最基本的测试思路。如果界面上有一个输入框,以下几个测试用例肯定会有:

    • 输入非常多的字符,看是否允许、是否合理显示
    • 输入不应该允许的数值,比如超出最大最小值,看能否允许、能否继续下一步
    • 输入不应该允许的文本类型,比如身份证号栏填入中文,看是否允许、能否继续下一步

    下面几种测试手段,都会用到极端的思维:

    • 最低配置的设备上能否流畅运行
    • 在设备资源紧张(例如内存不足)的时候,程序还能否正常工作
    • 在最老旧的系统、浏览器版本上能否正常运行
    • 非常频繁地进行操作,程序还能否正常响应

    依据这个思维,产品经理应该把这些东西都定义清楚:

    • 可交互界面的输入类型与范围
    • 目标运行环境的最低配置
    • 兼容性:系统版本、浏览器品牌与版本
    • 需要支撑多少用户同时在线、多少同时发生的流量
    • 要能应对什么程度的故障

    测试思维:因果

    开发思维中“条件与时机”注重的是“前提”,测试还会做反向思考和补充。除了关心“什么条件导致了这个结果”,还要思考“这个条件会导致哪些结果”,这也是开发写代码容易疏忽的。两个典型的问题是:登录后可以做什么,界面上有哪些变化。这种思维在所有岗位都是适用的,也很容易理解,对产品经理的意义就不细说了。

    测试人员不仅用它来评审需求,找bug时要考虑是什么操作、事项、需求导致了bug以及这些东西的关联关系、影响范围等,从而进一步发现更多问题。

    而且作为需求的实现者,技术人员都会有这个问题:为什么要这样做,做成了会有什么结果。产品经理是有责任回答这个问题的。其中,“为什么要这样做”要心里有数,在需求评审时被问到就要能回答。不能靠想,要有根据:

    • 用户调研
    • 统计数据分析
    • 市场调查
    • 竞品分析
    • 成功经验

    还有“做成了的结果”应该把它以“目标”为第一章标题写到需求文档的前面。目标示例:

    • 解决用户购物流程中的不便
    • 给占比有27%的喜欢xxx用户增加一种选择,可以对xxx进行操作
    • 转化率至少有12%
    • 提升月活跃度10%(或到30%)
    • 提高广告月收入至300万

    产品经理做需求时,应该先想好这些目标,需求是围绕这些目标来制定的。大家理解这个目标后,还能帮助产品经理想出更多更好的方案来达成。

    测试思维:场景

    “场景”在本文中意为多个条件共同作用的情况。下表表示的是两个条件(行为、身份)下的结果(权限)。

    行为-身份-权限表游客普通会员VIP会员
    购物不可以可以可以
    看视频可以可以可以
    评论中发表情不可以不可以可以

    设想增加一个情况:已绑定微信的会员可以查看“朋友积分榜”。这就需要一个“行为-身份-微信绑定-权限表”。如果有更多条件,就不是一个表格能说明的了。合格的测试人员会把这些条件的所有交叉情况都测一遍,甚至在需求评审后就要做用例设计,把需求文档没覆盖的情况立刻指出来。

    场景的本质是条件的排列组合,可以用数学公式计算出有多少可能性。产品经理不应该把这些情况推托给技术人员去想,因为最极端的情况是可能会发现某些场景无解,以致要推翻整个需求。到评审完才发现这些问题就晚了,耽误了太多人的时间。

    当场景过于复杂,除了要说清楚规则外,还应该写出示例来帮助理解。

    用户体验思维:层次分明、重点突出

    产品经理或设计师做网页设计时通常会有这些原则:

    • 方便从上到下阅读,页面不会产生横向滚动条。
    • 描述一个宏观事物的图不会跨越两屏才看完整
    • 层次分明:标题比正文的颜色更深、字号更大、字形更粗。
    • 段落内部的重点词句(一般是超链接)要使用更显眼的颜色,字形可以使用粗体、斜体、下划线等。

    无论需求文档是写Word还是用Axure导出网页给技术同事看,以上原则都是适用的:帮助提升阅读效率。

    还有一个问题是表格的运用。表格能让人一下看到哪里有填东西哪里是空白,但并不方便人仔细阅读所有的内容。什么时候用表格或列表,这里总结两个简单规则:

    • 表格除表头外至少有3行3列,否则用列表。
    • 如果表格写不出精确的表头来,也就是每行是不同意义的,用列表。

    最后就是,写需求用Word还是Axure或两者结合,都无所谓,关键是要把事项描述清楚并且方便查阅。

    思维应用

    上述思维的运用,最终是为了提高需求的完善程度,避免需求本身有bug。产品经理要去学习技术知识的话,应该是要总结出更多的思维,而不是真的要会写代码。以下按照界面和交互来总结一下技术思维的关注点。

    界面组件上的应用:

    • 文本框
      • 过长如何显示:换行、显示省略号
      • 如果换行和省略号都不要,就要确定文案最大字数
      • 数字保留多少位小数,四舍五入还是去尾或进1
      • 数字的显示格式,例如加逗号或加单位
      • 时间的显示格式,例如是否显示分秒,日期间用中文还是横线连接
    • 输入框
      • 默认值
      • 占位符
      • 按下回车的行为
      • 自动补全的规则
      • 可输入类型:纯数字、文本(中文、外文、特殊字符),是否密码
      • 输入限制:文本长度、小数位数、取值范围、最大最小值、是否必填
    • 选择框
      • 默认状态
      • 单选还是多选
    • 下拉列表
      • 默认值
      • 实际值与显示值的对应关系:例如界面上显示100+,实际值是135
    • 按钮:点击后的行为
    • 弹框
      • 位置:屏幕中间或中下
      • 显隐动画:时长、方式
    • 表格
      • 排序规则
    • 开关
      • 默认状态
    • 轮播
      • 是否自动换页,间隔时间
      • 是否显示分页器(“点点”或页码),是否可点击分页器来换页
      • 是否可循环
      • 是否显示进度条
      • 是否增加每页边距,边距是多少
    • 图片
      • 缩放规则,例如固定宽度、高度随原比例
    • 层级:谁可以遮盖谁

    交互上的应用:

    • 点击:反馈形式(例如变色)
    • 手势(例如右滑后退)
      • 距离
      • 速度
      • 方向
    • 界面切换
      • 动效:时长
      • 窗口、屏幕改变大小(横竖屏切换)的布局规则
      • 已输入的数据是否保留
    • 关联关系。例如选中后会立刻改变其它控件的状态
    展开全文
  • react开发技术文档

    2017-12-28 10:35:16
    react中文用户手册,react使用,前端开发介绍以及讲解
  • 项目开发中如何说明文档

    万次阅读 2017-11-21 18:44:11
    叫你怎么写开发文档:步骤描述:步骤描述需要一定的逻辑性。但不一定是纯文字形式,可以用公式,便于理解的伪代码+文字等方式进行步骤描述

    第一节 总流程
    一、(原理介绍)
    XXXXXXXXXXXXXXXXXX
    二、(总的流程图)

    第二节:主接口1
    一、(原理介绍)
    XXXXXXXXXXXXXXXXXXXXXXXXX
    二、(总的流程图)

    例子:
    流程图
    这里写图片描述

    步骤描述:步骤描述需要一定的逻辑性。但不一定是纯文字形式,可以用公式,便于理解的伪代码+文字等方式进行步骤描述
    这里写图片描述
    这里写图片描述
    这里写图片描述

    这里写图片描述
    这里写图片描述

    三、分模块介绍
    1、逻辑模块一:
    1.1 代码
    1.2 流程图
    1.3 详细说明

    例子:
    1、 三个框相交,则去掉中间的
    这里写图片描述
    这里写图片描述

    1.  if(detectResult.size() > 1)  
    2.      for(int i=1;i<detectResult.size()-1;i++){  
    3.          if (((detectResult[i].x + detectResult[i].width + 2) >= detectResult[i + 1].x) &&  
    4.              (detectResult[i].x <= (detectResult[i - 1].x + detectResult[i - 1].width - 2))){  
    5.          }  
    6.          if (((detectResult[i].x + detectResult[i].width + 2) >= detectResult[i + 1].x) &&  
    7.              (detectResult[i].x <= (detectResult[i - 1].x + detectResult[i - 1].width - 2))  
    8.              && ((detectResult[i + 1].x - detectResult[i - 1].x - detectResult[i - 1].width) < (0.7*(ROIWIDTH + avg_distance_of_chars)))){  
    9.              detectResult.erase(detectResult.begin() + i);  
    10.             i--;  
    11.         }                     
    12.     }
    

    2、接口模块:
    2.1 代码
    2.2 功能描述
    2.3 接口描述
    2.4 核心原理

    例子1:
    以cifar-10为例说明,具体的运算过程,对应代码:
    这里写图片描述
    1、卷积:
    1.

    inline void Conv(const int *restrict pSrc, int *restrict pDst, const int *restrict pKer, const int input_w, const int input_h, int k_size, int stride)  
    2.  {  
    3.      int   y, i, j, k;  
    4.      int tSum;  
    5.      const int *pSS = pSrc;  
    6.    
    7.    
    8.      for (y = 0; y< (input_h + stride - 1) - k_size + 1; y += stride, pSS += (stride*input_w))  
    9.      {  
    10.         for (i = 0; i<(input_w + stride - 1) - k_size + 1; i += stride)  
    11.         {  
    12.             tSum = 0;  
    13.             for (j = 0; j<k_size; j++)  
    14.             {  
    15.                 for (k = 0; k<k_size; k++)  
    16.                 {  
    17.                     tSum += pSS[j * input_w + i + k] * pKer[j * k_size + k];                      
    18.                 }  
    19.             }  
    20.   
    21.             *pDst++ = tSum;   
    22.         }  
    23.     }  
    24. }  

    1.1 功能描述
    宽为input_w、高为input_h的输入图像pSrc,与k_size x k_size的卷积核pKer进行卷积,得到宽为input_w、高为input_h特征图pDst。

    1.2 接口描述
    这里写图片描述

    名称  In/out/Par  Size/precision  Description/value
    pSrc    in  input_w* input_h    输入图像
    pDst    out input_w* input_h    输出图像
    pKer    in  k_size * k_size 卷积核
    input_w parameter   int 输入图像宽
    input_h parameter   int 输入图像高
    k_size  parameter   int 卷积核宽,一般为奇数
    stride  parameter   int 卷积核在图像上上下左右滑动的平移像素幅度

    1.3 核心原理(以cifar-10为例进行说明):
    (1)输入是3个32*32, 共3*1024=3072。每条边padding为2,则内存里实际为3个36*36.
    (2)卷积核个数是3维的5*5分别与3个输入进行卷积运算,得到3维的32*32的输出,这里将3维的32*32对应位相加得到一张32*32的feature Map
    (3)输出:如果有64个3维的5*5卷积核就有64张feature Map
    具体过程图示为:
    这里写图片描述
    卷积的权值读取方式为:
    (1)第1个5*5作用于第一张输入全图,
    (2)第2个5*5作用于第二张输入全图,
    (3)第3个5*5作用于第三张输入全图,
    (4)再把这三个对应位置相加,在加上biases,得到第一张feature map
    (5)最后64个5*5*3重复上面的过程,得到64个featuremap
    (6)这里weights有3*5*5*64个,biases有64个.
    这里输入是3 个图像,输出是64个特征图,卷积核是5*5权值个数是64* 5*5*3

    例子2:

    这里写图片描述

    展开全文
  • jira插件开发技术文档

    热门讨论 2012-02-18 21:52:33
    我在做jira插件开发中整个过程中的步骤工作内容等,有详细的指导和说明,都是自己一点点积累下来的文档,公司让的,当然我要偷偷放上来共享一把咯
  • 你会写开发文档

    千次阅读 2017-12-25 16:26:38
    你会软件开发文档吗? 如今,软件开发越来越复杂,软件的功能也越来越丰富。而几乎所有成熟的商业软件,都是一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的。”,当我们震撼于Microsoft ...

    你会写软件开发文档吗?


    如今,软件开发越来越复杂,软件的功能也越来越丰富。而几乎所有成熟的商业软件,都是一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的。”,当我们震撼于Microsoft Windows的惊世巨著的同时,也道听途说了一些微软公司软件工程是如何的完善和规范。软件项目管理的成败是控制开发成本的关键环节。这里面,少不了贯穿其中的重要步骤——软件文档。

    软件文档可以分为开发文档和产品文档两大类:

    开发文档包括:《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。

    产品文档包括:《产品简介》、《产品技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。

    一、开发文档

    1. 《功能要求》——来源于客户要求和市场调查,是软件开发中最早期的一个环节。客户提出一个模糊的功能概念,或者要求解决一个实际问题,又或者是参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书,把他们的要求全部列表书写在文档中,必要时加以图表解说。这份文档是需求分析的基础。

    2. 《投标方案》——根据用户的功能要求,经过与招标方沟通和确认,技术人员开始书写《投标方案》,方案书一般包括前言、需求分析、技术方案、项目管理、技术支持、系统报价、项目进度等。

    3. 《需求分析》——包括产品概述、主要概念、操作流程、功能列表、注意事项、系统环境等。以《功能要求》为基础,进行详细的功能分析,列出本产品是什么,有什么特殊的概念,包括那些功能分类,需要具备什么功能,该功能的操作如何,实现的时候该注意什么细 节,客户有什么要求,系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。

    4. 《技术分析》——包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价,竞争对手技术分析等。以《需求分析》为基础,进行详细的技术分析(产品的性能和实现方法),列出本项目需要使用什么技术方案,为什么,有哪些技术问题要解决 ,估计开发期间会碰到什么困难,技术方案以后如何升级,对本项目的技术有什么评价等。

    5. 《系统分析》——包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础,进行详细的系统分析(产品的开发和实现方法),程序员根据《系统分析》,开始在项目主管的带领下进行编码工作。

    6. 《数据库文档》——包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础,进行详细的数据库设计,必要时可以用图表解说,特别是关系数据库。

    7. 《功能函数文档》——包括变量名、变量初植、功能、函数名、参数、如何调用、备注、注意事项等。以《系统分析》为基础,进行详细的说明,列出哪个功能涉及多少个函数,以便以后程序员修改、接手和扩展。

    8. 《界面文档》——包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求,这里与软件完成后的运行界面是一致的。

    9. 《编译手册》——包括服务器编译环境、操作系统、编译工具、编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。

    10. 《QA文档》——包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等,提供给软件测试人员使用。

    11. 《项目总结》——包括项目简介、项目参与人员和开发时间、项目风险、管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员工作情况等。

    二、产品文档

    1. 《产品简介》——包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址等。

    2. 《产品演示》——包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Powerpoint或者视频录制软件实现。

    3. 《疑问解答》——列出用户关心的问题和处理方法,用于解答软件的操作功能和解决用户的疑难问题。

    4. 《功能介绍》——以《需求分析》为书写基础,包括软件介绍、软件结构、功能列表、功能描述等。

    5. 《技术白皮书》——以《技术分析》为书写基础,包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。

    6. 《评测报告》——第三方的权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。

    7. 《安装手册》——包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。

    8. 《使用手册》——包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。

    9. 《维护手册》——包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。

    10. 《用户报告》——包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。

    11.《销售培训》——包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。

    展开全文
  • java开发技术文档

    2013-06-04 00:37:59
    java入门开发指导,介绍关于java相关代码的作用
  • Spring MVC开发技术文档内涵Spring2.5-中文参考手册,spring3.0MVC注解,对新手学习spring mvc技术有很大的帮助!
  • 题目:ISO9001质量体系作业文件 软件开发技术文档管理规范。软件开发的不同阶段都会产生大量的文档。为了加强管理、提高工作效率, 充分借鉴前人的经验, 对文档进行规范化管理是很有必要的。 它对于保管在开发中...
  • 适合技术部的KPI考核,软件开发、java技术的考核,适合各开发
  • 这个文档的确需要有一定的经验,要么产品设计经验,要么是技术开发经验的人来做比较好,看我们公司的产品经理搞了7、8份,就是三步走: 1、需要清晰的业务场景和逻辑,能用文字表述出来的那种; 2、制作一个业务...

    微信服务商开发能力说明文档怎么写

    这个文档的确需要有一定的经验,要么产品设计经验,要么是技术开发经验的人来做比较好,看我们公司的产品经理搞了7、8份,就是三步走:
    

    1、用文字清晰表述出来业务逻辑;
    2、画一个业务流程图(类似下图);
    3、画一个资金流向图(下图);
    做出以上3个文件就可以提交了。
    还是不懂或者嫌麻烦,可以找他帮忙搞一下,很有经验的VX【markmiao166】
    在这里插入图片描述

    展开全文
  • java web开发技术文档的编写

    千次阅读 2020-04-17 17:18:52
    开发文档: 项目开发过程中为了增加程序的可读性和程序的健壮性, 方便后期程序的调试和维护,所以需要在开发过程中统一技术规范,一般会在项目初期确定好相关文档作为这一统一的规范。不同公司会对文档做不同要求...
  • 软件开发技术文档编写规范

    万次阅读 多人点赞 2017-12-29 09:40:14
    在项目开发过程中,应该按要求编写好十三种文档文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。  ◇可行性分析报告:说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述...
  • 概要设计说明书说明对软件总体的考虑,包括程序的基本流程、程序的组织结构、输入/输出、接口设计、运行设计、数据结构设计和系统出错设计等,为系统的详细设计打好基础。
  • 用markdown编辑器写技术接口文档

    千次阅读 2017-01-05 17:49:38
    一直想找一套开源程序来写接口文档,看过showdoc,swagger之类的,感觉都不是很方便 ,后来发现还是用markdown写技术接口文档比较方便! 写md文件推荐使用gitbook 下载地址 ...——用户中心 ———-登录.md ...目录文件写好,
  • Vue中文社区 独家公众号,面向前端爱好者, 每日更新最有料的文章,最前沿的资讯,内容包含但不限于Vue,React,Angular,前端工程化...等各种"大保健"知识点,右上角...
  • 软件开发技能实训教程——技术文档篇(跟Microsoft工程师学技术文档编写
  • HTML5开发APP技术文档

    千次阅读 2018-03-05 17:36:22
    HTML5开发APP技术文档 &nbsp; 一、环境参数 1、技术语言:HTML、CSS、ES6、Node.js等; 2、框架:Vue.js 2.x、Cordova; 3、开发系统:mac、windows等; 4、环境配置: node 6+ npm 3+ (最好下载Node.js官方...
  • 技术开发合同免税政策

    万次阅读 2016-07-11 14:57:45
    随着国家大力支持高新技术企业的发展,制定相关税收优惠政策,原技术开发合同减免营业税,营改增后国家继续执行高新技术企业的税收优惠政策,减免增值税。以下学习啦小编为大家精心准备了:技术开发合同的免税政策,希望...
  • 软件开发人员为什么不愿意写文档

    千次阅读 2015-01-05 10:06:47
    软件开发人员不愿意写文档,我想这主要指的是刚参加工作时间不长的工作人员。真正的老鸟是不会这样的。我说说自己的看法,希望大家讨论。  1.软件开发的大环境不好  软件开发行业在中国的兴起也就是十
  • 刘霄前端技术开发日志

    千次阅读 2012-02-20 14:33:14
    1.所有文件包括,华夏银行信用卡商城首页、频道页、注册流程、购物流程、高级搜索、最终产品页面等6个功能模块10几个界面,以及设计说明文档一份。 2.要求使用所掌握的前端开发技能(css+div+js)...
  • 作者:园长 ...简评:因为 README,6 个月后的你仍然知道当初了什么;因为 README,其他人看一眼就能知道是否需要;因为 README,让你的代码更有质量;因为 README,你成了个作家。 README 是一种说
  • 代码 可执行文件 加上开发文档 是用类来的 结构比较简单
  • 软件开发文档总结

    千次阅读 2015-11-01 21:06:40
    前言:  最近一个多星期都在文档,刚开始文档... 软件开发文档是软件开发和维护过程中的必备资料。它能提高软件的开发效率,保证软件的质量,而且在软件的使用过程中有指导、帮助、解惑的作用。尤其是在维护阶段
  • 如何编写一个项目开发文档

    万次阅读 多人点赞 2018-09-29 21:51:31
    项目开发过程中为了增加程序的可读性和程序的健壮性, 方便后期程序的调试和维护,所以需要在开发过程中统一技术规范,一般会在项目初期确定好相关文档作为这一统一的规范。不同公司会对文档做不同要求,划不同的...
  • 软件开发文档-详细设计文档

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

    千次阅读 2019-01-14 14:07:32
    编码的规范是提高程序开发效率和可读性的必备利器,于是就看了看阿里巴巴的编码规约,该文档已经开源,本想着在博客中直接上传的,结果发现已经重复,为了给自己养成整理资料的习惯,现在只好把文件放在了gitee上面...
  • 前端开发相关技术API文档汇总

    千次阅读 2014-02-14 11:07:49
    yeoman文档 官网: http://yeoman.io/ 中文版: http://yeomanjs.org/ grunt https://github.com/gruntjs/ http://www.gruntjs.org/article/grunt_file.html requireJS ...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 1,373,894
精华内容 549,557
关键字:

技术开发文档怎么写