最近公司開發項目需要前后端分離，這樣話就設計到后端接口設計。復雜功能需要提供各種各樣的接口供前端調用，因此編寫API文檔非常有必要了 網上查了很多資料，發現基於Markdown編寫文檔是一種比較流行而且成熟的方案了，話不多說，我也搞一搞試試。 電腦操作系統：deepin深度 Linux64位 ...

https://www.showdoc.cc ...

0. 前言 近期忙於和各個銀行的代收接口聯調，根據遇到的問題，對之前編寫的接口進行了修改，需求收集和設計接口時想到了方方面面，生產環境下還是會遇到意想不到的問題，好在基本的執行邏輯已確定，因此只是對接口進行了一些微調，但是收錢無小事，之前在代碼編寫時對參數進行了很多的校驗，代碼修改之后一個參數 ...

軟件開發中文檔的編寫是一個不可缺少的環節，常見的如《需求分析》、《概要分析》、《數據庫設計》等。在“軟件人”的陣營里向來存在兩種觀點，注重文檔還是關心代碼。一直爭論多少年了，好像都沒有一個真正的定亂。如果大項目且開發周期相對合理，很多時候項目組一定會安排進行相關開發文檔的編寫；但對於周期短 ...

每個系統都包含一系列架構決策，定義了設計和實現的邊界和限制， 架構設計文檔的核心是以某種方式的選型決策，而開發團隊可能不太清楚這個決策背后的假設和思考。 對於這些決策，由於我們缺少當時的上下文，只能盲目的接受 ...

參考自網友的鏈接： https://www.jianshu.com/p/8da35d1f987a ...