如何寫好產品需求文檔？
常常有人問我怎么寫prd，在深受市面上流行的功能需求模板“殘害”之后，我現在一般不會向別人推薦任何所謂的“模板”。 需求文檔是產品需求的表達方式，而其中需要描述什么內容取決於產品經理想要描述什么，即產品經理的需求。如果產品經理的需求是明確的，而且產品經理腦中有物，那么需求文檔自然而然就出來 ...
原文：研發團隊如何寫好API接口文檔
導讀 背景 痛點在哪 為什么要寫接口文檔 API規范 接口工具 總結 背景 隨着業務的發展,支撐組的項目也是越來越多。同時,從整個支撐組項目架構體系 含運維和運營體系 ,我們對系統業務水平拆分,垂直分層,讓業務系統更加清晰,產生了一系列平台和子系統,並使用接口進行數據交互。伴隨着業務的發展,接口營運而生,並且會越來越多。 痛點在哪 我們運營和維護着諸多的對外接口,很多現有的接口服務寄宿在各個不同 ...
2018-05-30 13:07 2 10668 推薦指數：
相關推薦
如何寫好產品幫助文檔？
大多數程序員都不喜歡寫文檔，有寫文檔時間，還不如重構一遍代碼。早前我也這么認為，究其原因，一則自己不喜歡也不擅長寫文檔，代碼是給機器讀的，只要語法和邏輯沒問題，計算機就會聽命執行，而文檔是寫給人看的，除了語法和邏輯，好文檔還要照顧讀者的心理；二則傳統軟件的客戶對文檔無感，它僅僅作為合同 ...
怎樣寫好接口文檔
內容概要 寫接口文檔的四種方式 DRF 自動生成接口文檔步驟（coreapi） 接口文檔組成 內容詳細 寫接口文檔的四種方式 目前流行的前后端分離模式，在前后端進行數據交互之前，后端需要把數據交互的接口的作用、地址、格式等信息提供給前端，需要我們書寫標准的接口文檔 ...
如何寫好一篇技術型文檔？
如何寫好一篇技術型文檔 周智 2022/1/20 參加工作時間久一點的工程師應該有這樣一個體會：自己平時代碼寫得再多再好，可一旦要用文檔去描述或者表達某一個事情或者問題時，都感覺非常困難，無從下手，不知道自己該寫什么不該寫什么；或者費了九牛二虎之力寫出來的東西沒法滿足要求，需要再三去修改 ...
如何寫好項目規划和方案設計文檔 (轉)
在工作中，很多時候，我們都需要就一個問題提出一個解決方案，這時候，我們很可能需要產出一個文檔來供大家討論，並指導下一步工作計划。 問題可大可小，形式上是否叫它為一個項目並不重要，重要的是為了解決這個問題，項目規划和方案設計的流程 ...
如何寫好簡歷呢
簡歷該如何寫好，也是很關鍵的，下面是一個模版，也不知道怎么樣，在智聯招聘上看到的，拿來參考一下。 簡歷模板:Java工程師 智聯招聘 姓名 ...
如何寫出安全的API接口
通過園友們的討論，以及我自己查了些資料，然后對接口安全做一個相對完善的總結，承諾給大家寫個demo，今天一並放出。 對於安全也是相對的，下面我來根據安全級別分析 1.完全開放的接口 有沒有這樣的接口，誰都可以調用，誰都可以訪問，不受時間空間限制，只要能連上互聯網就能調用 ...
什么是接口文檔，如何寫接口，有什么規范？
一、什么是接口文檔？在項目開發中，web項目的前后端分離開發，APP開發，需要由前后端工程師共同定義接口，編寫接口文檔，之后大家都根據這個接口文檔進行開發，到項目結束前都要一直維護。 二、為什么要寫接口文檔？1、項目開發過程中前后端工程師有一個統一的文件進行溝通交流開發 ...