如何写好产品需求文档？
常常有人问我怎么写prd，在深受市面上流行的功能需求模板“残害”之后，我现在一般不会向别人推荐任何所谓的“模板”。 需求文档是产品需求的表达方式，而其中需要描述什么内容取决于产品经理想要描述什么，即产品经理的需求。如果产品经理的需求是明确的，而且产品经理脑中有物，那么需求文档自然而然就出来 ...
原文：研发团队如何写好API接口文档
导读 背景 痛点在哪 为什么要写接口文档 API规范 接口工具 总结 背景 随着业务的发展,支撑组的项目也是越来越多。同时,从整个支撑组项目架构体系 含运维和运营体系 ,我们对系统业务水平拆分,垂直分层,让业务系统更加清晰,产生了一系列平台和子系统,并使用接口进行数据交互。伴随着业务的发展,接口营运而生,并且会越来越多。 痛点在哪 我们运营和维护着诸多的对外接口,很多现有的接口服务寄宿在各个不同 ...
2018-05-30 13:07 2 10668 推荐指数：
相关推荐
如何写好产品帮助文档？
大多数程序员都不喜欢写文档，有写文档时间，还不如重构一遍代码。早前我也这么认为，究其原因，一则自己不喜欢也不擅长写文档，代码是给机器读的，只要语法和逻辑没问题，计算机就会听命执行，而文档是写给人看的，除了语法和逻辑，好文档还要照顾读者的心理；二则传统软件的客户对文档无感，它仅仅作为合同 ...
怎样写好接口文档
内容概要 写接口文档的四种方式 DRF 自动生成接口文档步骤（coreapi） 接口文档组成 内容详细 写接口文档的四种方式 目前流行的前后端分离模式，在前后端进行数据交互之前，后端需要把数据交互的接口的作用、地址、格式等信息提供给前端，需要我们书写标准的接口文档 ...
如何写好一篇技术型文档？
如何写好一篇技术型文档 周智 2022/1/20 参加工作时间久一点的工程师应该有这样一个体会：自己平时代码写得再多再好，可一旦要用文档去描述或者表达某一个事情或者问题时，都感觉非常困难，无从下手，不知道自己该写什么不该写什么；或者费了九牛二虎之力写出来的东西没法满足要求，需要再三去修改 ...
如何写好项目规划和方案设计文档 (转)
在工作中，很多时候，我们都需要就一个问题提出一个解决方案，这时候，我们很可能需要产出一个文档来供大家讨论，并指导下一步工作计划。 问题可大可小，形式上是否叫它为一个项目并不重要，重要的是为了解决这个问题，项目规划和方案设计的流程 ...
如何写好简历呢
简历该如何写好，也是很关键的，下面是一个模版，也不知道怎么样，在智联招聘上看到的，拿来参考一下。 简历模板:Java工程师 智联招聘 姓名 ...
如何写出安全的API接口
通过园友们的讨论，以及我自己查了些资料，然后对接口安全做一个相对完善的总结，承诺给大家写个demo，今天一并放出。 对于安全也是相对的，下面我来根据安全级别分析 1.完全开放的接口 有没有这样的接口，谁都可以调用，谁都可以访问，不受时间空间限制，只要能连上互联网就能调用 ...
什么是接口文档，如何写接口，有什么规范？
一、什么是接口文档？在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。 二、为什么要写接口文档？1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 ...