Hi 我是朱騏 👋
這週我要推薦一個超讚的「學習寫 API 文件」的課程!
如果你是以下 3 種人,我強烈建議好好讀一讀
技術寫手:不用說,一定要看的。
軟體產品經理:你會更了解前後端工程師在開發時需要的產品規格,並且知道自家公司的產品如何跟外部夥伴串接系統。
工程師:你可以設身處地的引導使用自家 API 的外部開發者、使用者,給他們一個超讚的使用體驗 (那些寫的不清不楚的 API Doc,真的會讓人血壓飆高)。
ㄟ…那如果以上 3 個我都不是怎麼辦呢?
那你更要看,因為這堂課真的太厲害了!
我很好奇這個老師到底有多強的寫作與教學功力,才能把一堂其他老師教的又複雜、又讓人想睡覺的課程,設計的如此容易上手。(重點:還是免費的)。
我就不破梗了,你就自己往下看吧。
P.S. 下週 & 下下週 (3/28, 4/4) 我要去義大利渡蜜月啦,這幾個月一邊上班、一邊弄自媒體真的蠻累的,趁這個時間給自己充個電。
我們 4/11 再會啦 🇮🇹 Ciao!
1 ACTION
如何寫一份好讀的 API 技術文件?推薦學習技術寫作的好資源 — Documenting APIs
閱讀時間: 1 分鐘
我擔任技術寫手 (Technical Writer) 也快 1.5 年了,這段時間寫的都是公司的產品使用手冊操作說明。但是寫久後,發現自己的成長已經停滯了…是時候該升級技術寫手的新技能 — 寫 API 文件。
但是…寫一份清楚好讀的 API 文件真的很難。
相對於產品使用手冊,API 技術文件的學習門檻更高,包含要了解 API 基礎知識 (例如 REST API)、cURL 命令列、JSON Response、前端工程師如何使用 API…等,才能寫出一份好的 API 文件
更難的是,連個線上課程都很難找!
在 Google 搜尋「api documentation tutorial」,跳出來的 Udemy, freeCodeCamp 的課程,真的都…蠻鳥的。這些課程都千篇一律的教你要先從了解讀者是誰、盤點公司內部的 API 有哪些、記得要舉例…等。
我都同意,因為都是…看起來正確的廢話。我極度痛恨這種打高空的教學!
但幸運的是,我在 Write the Doc 這個全球技術寫手的 Slack 頻道中,看到網友推薦 Tom Johnson 的超讚課程-Documenting APIs。
學習這份教材,真的是一個享受!
👉 繼續閱讀
2 THOUGHTs
閱讀時間: 1 分鐘
💭 上班族經營自媒體的 3 個好處
大概念: 2019 年我開始在網路部落格 Medium 上寫作,分享自己在軟體業新創擔任 PM 的工作經驗。
深入了解: 就算你是上班族、目前也還沒有要靠創作來賺錢,經營自媒體還是可以給你的正職工作帶來 3 個好處。
💭 讓生活變得更輕鬆!使用 ChatGPT AIPRM 插件的 3 個好處
大概念: AIPRM 是我目前使用 ChatGPT 最方便的插件。
深入了解: 這篇貼文分享此款插件 3 個好用的地方,看完後你的下一步行動就是:馬上去 Google 插件商店安裝它!
3 IDEAs
用 AI 機器人輔助閱讀 PDF - PandaGPT閱讀時間: 1 分鐘
大概念: 上週我介紹了一款 ChatPDF 工具,可以上傳 PDF 檔案並且用問答的方式來閱讀書籍。這一款 PandaGPT 的功能也很類似。
重點: PandaGPT 跟 ChatPDF 的功能雖然相似,但 PandaGPT 的使用介面設計的更好,左側是聊天視窗、右側是 PDF 檔案,可以邊聊天邊閱讀。
👉 PandaGPT
使用 AI 幫忙進行 Zoom/Google Meet/ Teams 的會議逐字稿與總結
閱讀時間: 1 分鐘
大概念: Grain 可以針對 Zoom/Google Meet/ Teams 的會議內容進行逐字稿翻譯與總結
重點:這款工具適合老師、職場上班族、使用者訪談...等,看起來非常吸引人呀!
👉 Grain
給軟體業不同職位的人,可以使用的 ChatGPT Prompt - JobGPT
閱讀時間: 1 分鐘
大概念:這個網站以職位 (Job) 作為 Prompt 的分類元素。
重點:網站中分成軟體工程師、數據科學家、人力資源、學生、產品經理、業務、求職者,我很喜歡用職位來區分能使用的 Prompt!
👉 JobGPT