JavaShuo
欄目
標籤
客戶端SDK接入文檔,這麼寫就對了 | 技術寫作
時間 2020-12-31
標籤
java
android
編程語言
linux
大數據
欄目
Java
简体版
原文
原文鏈接
開發文檔通常包括哪些類型?命令說明、錯誤信息說明、告警說明、事件說明、關鍵技術指標說明……但是,在雲服務的世界裏,個人以爲,最常用到的2類開發文檔是,API接口說明(下文簡稱「API文檔」)和SDK接入說明(下文簡稱「SDK文檔」)。 作爲產品的重要組成部分之一,文檔的質量一定程度上反映了產品的質量。如果文檔質量無法滿足用戶需求,可能會勸退試用產品的潛在用戶。同時,如果用戶無法通過文檔獨立使用產品
>>阅读原文<<
相關文章
1.
技術文檔寫作的道與術
2.
編寫接口文檔 APIPost 客戶端使用和導出接口文檔
3.
gitBook 寫技術文檔
4.
如何寫技術文檔
5.
做了這麼多年的技術,你有寫過博客嗎?
6.
怎麼寫接口文檔
7.
技術需求文檔,應當這麼寫!
8.
web項目引入這個框架就不用再寫接口文檔了!
9.
文檔寫作
10.
四個月技術寫作,我寫了些什麼?
更多相關文章...
•
XSLT - 在客戶端
-
XSLT 教程
•
C# 文本文件的讀寫
-
C#教程
•
三篇文章瞭解 TiDB 技術內幕——說存儲
•
三篇文章瞭解 TiDB 技術內幕 —— 說計算
相關標籤/搜索
寫了
寫寫
技術文檔
寫文
寫入
JEECG技術文檔
webService客戶端
客戶端
論文寫做
Java
Linux
Android
PHP教程
Hibernate教程
MyBatis教程
技術內幕
後端
文件系統
0
分享到微博
分享到微信
分享到QQ
每日一句
每一个你不满意的现在,都有一个你没有努力的曾经。
最新文章
1.
《給初學者的Windows Vista的補遺手冊》之074
2.
CentoOS7.5下編譯suricata-5.0.3及簡單使用
3.
快速搭建網站
4.
使用u^2net打造屬於自己的remove-the-background
5.
3.1.7 spark體系之分佈式計算-scala編程-scala中模式匹配match
6.
小Demo大知識-通過控制Button移動來學習Android座標
7.
maya檢查和刪除多重面
8.
Java大數據:大數據開發必須掌握的四種數據庫
9.
強烈推薦幾款IDEA插件,12款小白神器
10.
數字孿生體技術白皮書 附下載地址
本站公眾號
歡迎關注本站公眾號,獲取更多信息
相關文章
1.
技術文檔寫作的道與術
2.
編寫接口文檔 APIPost 客戶端使用和導出接口文檔
3.
gitBook 寫技術文檔
4.
如何寫技術文檔
5.
做了這麼多年的技術,你有寫過博客嗎?
6.
怎麼寫接口文檔
7.
技術需求文檔,應當這麼寫!
8.
web項目引入這個框架就不用再寫接口文檔了!
9.
文檔寫作
10.
四個月技術寫作,我寫了些什麼?
>>更多相關文章<<