客戶端SDK接入文檔,這麼寫就對了 | 技術寫作

開發文檔通常包括哪些類型?命令說明、錯誤信息說明、告警說明、事件說明、關鍵技術指標說明……但是,在雲服務的世界裏,個人以爲,最常用到的2類開發文檔是,API接口說明(下文簡稱「API文檔」)和SDK接入說明(下文簡稱「SDK文檔」)。 作爲產品的重要組成部分之一,文檔的質量一定程度上反映了產品的質量。如果文檔質量無法滿足用戶需求,可能會勸退試用產品的潛在用戶。同時,如果用戶無法通過文檔獨立使用產品
相關文章
相關標籤/搜索