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.
部署Hadoop(3.3.0)僞分佈式集羣
2.
從0開始搭建hadoop僞分佈式集羣(三:Zookeeper)
3.
centos7 vmware 搭建集羣
4.
jsp的page指令
5.
Sql Server 2008R2 安裝教程
6.
python:模塊導入import問題總結
7.
Java控制修飾符,子類與父類,組合重載覆蓋等問題
8.
(實測)Discuz修改論壇最後發表的帖子的鏈接爲靜態地址
9.
java參數傳遞時,究竟傳遞的是什麼
10.
Linux---文件查看(4)
本站公眾號
歡迎關注本站公眾號,獲取更多信息
相關文章
1.
技術文檔寫作的道與術
2.
編寫接口文檔 APIPost 客戶端使用和導出接口文檔
3.
gitBook 寫技術文檔
4.
如何寫技術文檔
5.
做了這麼多年的技術,你有寫過博客嗎?
6.
怎麼寫接口文檔
7.
技術需求文檔,應當這麼寫!
8.
web項目引入這個框架就不用再寫接口文檔了!
9.
文檔寫作
10.
四個月技術寫作,我寫了些什麼?
>>更多相關文章<<