技术文档编写经验总结

又一个项目即将结束，从编写技术文档、代码开发到联调，8个人还不到两周的时间，居然完成了，想想自己都很吃惊。

虽然是个小项目，但还是有很多东西需要沉淀下来。

正好晚上吃饱了没事干，写个博客记录一下技术文档编写经验^_^

1、对于一个快速迭代的项目，存粹、简单的数据模型+接口描述式的技术文档对整个项目还是有指导、推进性作用的。

2、技术文档可以多个人合作搞定，但是需要默契的配合，比如接口先写完，数据模型中的定义字段就需要和接口相匹配；接口参数命名遵循一定模式，可以是驼峰式的。

3、一般来说，开发需要严格遵循技术文档去编写，如果有不同意见，就需要开发人员及时向技术文档编写者提出，存在一个求同存异、逐步优化的过程。

4、开发完成之后需要压测、全路径覆盖集成测试、代码审计及修正才能具备上线条件，后续还需要考虑代码优化问题。

5、当然项目成功与否的关键是离不开大家的共同努力的，合作氛围很重要；另外，技术开发与业务场景相结合也是非常重要的一环。

技术文档编写经验总结相关推荐

android技术文档怎么写,技术文档编写指南
技术文档编写指南首先请阅读文案风格指南 ##学习产品使用方式最重要的必备的条件就是: 一定要亲自使用这个产品,至少是一遍通顺的流程要走完,不要求每一个接口都一定使用过,但是一个完整的功能片段是使用 ...
java web技术文档编写_Portal-Basic Java Web 应用开发框架 v3.0.1 即将发布（开发工作已完成，正在编写开发文档）...
Portal-Basic Web 应用开发框架(简称 Portal-Basic)是一套功能完备的高性能 Web 应用开发框架,内置可扩展的 MVC Web 基础架构和 DAO 访问接口(已内置 Hib ...
html游戏技术文档编写,HTML5编写的小游戏
HTML5编写的小游戏 HTML5 是什么东西?而 HTML5 的优势又在哪里?大家可以回顾之前一篇相关文章了解下 HTML5 知识:<深入分析:Flash VS HTML5到底谁统江山> ...
项目文档编写规范与代码规范
往往越是规模大的公司,其项目工作中的每一个环节都有相应的规范进行管理,这些规范都是都前辈呕心沥血,披荆斩棘所获的的经验总结,而非普通文书工作者的推猜可得. 当然,如果刚刚创业起步的小公司如能更早的抓住 ...
如何才能提高文档编写能力呢[转]
如何才能提高文档编写能力呢该如何才能提高文档编写能力呢,可以采用了以下几种方法,只要坚持不懈的做下去,相信会有提高. 1.尝试编写个人简历和经历,用文字来认识自己是不错的方法.要想别人认识你,首先自 ...
如何提升文档编写能力
在我身边的程序员中,无论是现在的同事还是过去的同事,普遍缺乏文档编写能力或能力严重不足,甚至有些编程能力很强的程序员也不能写出一篇可读性较强的设计说明书.产品手册等项目必备文档.其实,文档编写能力是成 ...
怎么才能写好技术文档？这是我的全部经验
▲ 点击上方"分布式实验室"关注公众号回复"1"抽取纸质技术书参加工作时间久一点的工程师应该有这样一个体会:自己平时代码写得再多再好,可一旦要用文档去描述或 ...
程序员如何编写高大上且实用的技术文档--转
原文链接:https://blog.csdn.net/qq_17324713/article/details/105895720?utm_term=%E7%A0%94%E5%8F%91%E6%8A%8 ...
sphinx 编码 php文档,用Sphinx编写技术文档
用Sphinx编写技术文档大家会发现,如果一个项目主要是用Python写的,其文档都很类似,比如:Python在线的HTML官方手册.这些项目的文档都来源于一个很不错的项目:Sphinx.这个Sph ...

技术文档编写经验总结

技术文档编写经验总结相关推荐

最新文章

热门文章