API design-first 方法的挑戰

6/10/2024

本文整理 API design-first 方法的挑戰。

要不要寫文件?

6/10/2024

從事全職 technical writer 即將屆滿一年,似乎是個適當時機整理一下工作心得與觀察。另一方面,我最近對公司內部單位以線上直播的形式做了兩次關於文件製作的簡報,也蒐集到一些問題和意見。故這一篇筆記,我會以 Q & A 的形式來說說我對「寫文件」這件事情的看法,並分享一些心得。

技術寫作入門:Docs as a product 與 content first

5/02/2024
本文整理了有關技術文件寫作的重要觀念,包括 docs as a product、內容優先,並說明如何構思文件架構。

Doc-as-Code 與知識管理系統

4/28/2024

你任職的公司裡面有沒有使用現成的知識分享平台或知識管理系統?例如 ConfluenceDocument360 等等。

Code review 的好處與 bad smells

4/14/2024

 In this post: 為何做 code review?並討論走味的 code review 有哪些狀況。


Redoc 生成的 OpenAPI 頁面左邊選單與 Bootstrap CSS 5.x 不相容

4/07/2024

問題症狀

以 Hugo+Docsy 工具組為基礎所建立的靜態網站,使用 Redoc 所 render 出來的 OpenAPI 頁面,其左邊選單連結無法正常運作:點連結之後無法跳到對應的內容所在位置。

GitHub Copilot 入門

2/19/2024

超級 lag 的我,終於也開始用 Copilot 啦。

《高品質軟體文件》筆記:維持文件的正確性

10/16/2023

 從書中摘出我特別有感的兩個段落,講的是關於保持文件的正確性(摘自第 1 章)。

技術提供:Blogger.
回頂端⬆️