工作周记 - 第八周 (2016/07/11 - 2016/07/15) 文档!文档!文档!

简介: 文档!文档!文档!重要的事情说三遍 1、项目一期基本开发完毕,包括后台管理系统以及提供给手机端的接口,由于奔着敏捷开发去的,文档没有过多花时间去写, 当然了文档肯定有,开发人员写的自己能看懂,但是对于对接人员来说看了就跟吃了屎一样难受 好吧,由于项目进度比原先提前,所以根据实际情况来修改文档,...

文档!文档!文档!重要的事情说三遍

1、项目一期基本开发完毕,包括后台管理系统以及提供给手机端的接口,由于奔着敏捷开发去的,文档没有过多花时间去写,

当然了文档肯定有,开发人员写的自己能看懂,但是对于对接人员来说看了就跟吃了屎一样难受

好吧,由于项目进度比原先提前,所以根据实际情况来修改文档,把文档修改得更加人性化,可读化

其实文档对于一些程序员来说,很瞧不起,但是,文档能力大家一定要提高,文档能力的提高可以给你未来带来很大的便捷

因为你要转管理,就必须要具备一定的文档能力

来看看文档模板吧,目前团体使用这样的格式来编辑的,比较不错,推荐个工具,那当然就是wiki了,没有wiki也不要紧,那就用word或者excel吧。。。

2、bug修改

  在对接过程中肯定会多少发现一些bug,一些比较明显的bug,当然了,看到就立即改掉

3、拦截器配置

  针对现有的所有接口,配置拦截器,把私有接口藏起来,公有接口开放

相关文章
|
Web App开发 前端开发 JavaScript
网页前端项目评审参考标准
网页前端项目评审参考标准
97 0
|
敏捷开发 存储 搜索推荐
《阿里巴巴Java开发手册v1.4.0(详尽版)》更新,新增16条设计规约
阿里巴巴集团推出的《阿里巴巴Java开发手册》是阿里巴巴近万名开发同学集体智慧的结晶,以开发视角为中心,详细列举如何开发更加高效、更加容错、更加有协作性,力求知其然,更知其不然,结合正反例,让Java开发者能够提升协作效率、提高代码质量。
734499 3
|
算法 Perl
技术下午茶:产品经理是如何工作的?如何才算一份好的需求文档?如何设计一个简单的列表,它应该具备哪些基本功能?
技术下午茶:产品经理是如何工作的?如何才算一份好的需求文档?如何设计一个简单的列表,它应该具备哪些基本功能?
119 1
如何撰写一份清晰有效的说明文档
在软件开发、产品开发以及各种工作任务中,编写一份清晰有效的说明文档是至关重要的。一份好的说明文档能够帮助读者理解事物的背景、目标和操作步骤,提高工作效率,减少沟通成本。
|
8月前
|
数据可视化 API uml
【有奖调研】开发文档功能升级:接口分组更清晰;增加参数中文名
【有奖调研】开发文档功能升级:接口分组更清晰;增加参数中文名
66 0
|
8月前
|
安全 前端开发 测试技术
【测开方法论】当老功能代码命名不规范的时候...如何安全增加新功能
【测开方法论】当老功能代码命名不规范的时候...如何安全增加新功能
|
8月前
|
搜索推荐 算法 UED
技术文档指南:版本说明、网站文案、FAQ、案例研究与内容优化
Release Notes 通常是软件文档的一部分,是在新产品发布时提供给用户的简短、高级摘要。它们包含有关更新的重要信息,包括新功能、增强功能、错误修复,通常还包括已知问题。每个版本说明与特定软件版本相关联,并帮助用户了解该特定版本中可以期待的哪些更改或改进。有效的版本说明将以用户为中心的方式讨论新功能或增强功能,识别用户需要执行的任何操作,突出已知问题和解决方法,并在必要时包含指向更详细信息的链接。它使用户能够更有效地使用软件并解决潜在问题。
254 0
|
8月前
|
前端开发 JavaScript NoSQL
假如你是一名专业的程序员,你将如何最快开发一个在线网站,并给出相应的代码及部署文档
假如你是一名专业的程序员,你将如何最快开发一个在线网站,并给出相应的代码及部署文档
64 0
|
关系型数据库 MySQL 数据库
MinDoc:针对IT团队的文档、笔记系统
作为一名IT从业者,无论是在公司团队中,还是在平时自己写一些笔记、博客等文档,我都习惯使用markdown来进行书写。在使用过许多支持markdown语法的系统或软件(如Typora、未知、我来、思源、觅道等)后,我总觉得它们不能满足我的需求。直到我发现了MinDoc这款针对IT团队开发的简单好用的开源文档管理系统。我们下面将介绍一下这个项目及如何使用docker-compose 快速部署。
281 1
MinDoc:针对IT团队的文档、笔记系统
|
弹性计算 前端开发 Linux
实验手册指导文档
主要介绍实验手册中的基本信息、实验资源配置、实验手册编写三项信息的填写规范,测试并提交审核和操作指南功能的使用方式。