技術寫作
含有「技術寫作」共 11 篇內容
全部內容
發佈日期由新至舊
本文整理了有關技術文件寫作的重要觀念，包括 docs as a product、內容優先，並說明如何構思文件架構。
本文主要在討論以 Docs as Code 方法來撰寫技術文件，此做法能否滿足企業內部對知識管理的需求。
學習寫API文件很困難，尤其很難在網路上尋找好的教材。在這篇文章中我會分你分享 Tom Johnson 的 “Documenting APIs” 課程。他提供了一個簡單的學習路徑，幫助你了解基礎 API 知識和寫作技巧。如果你想精進自己的 API 文件寫作能力，這個課程不要錯過！
對公司團隊來說，培養「寫文件」文化是非常棒的事情。例如降低新人 onboarding 時的教育成本、跨團隊溝通的時間成本。但多數的人都覺得「寫文件」是一件麻煩的事情。如果公司團隊要開始推行「寫文件」文化，應該如何做呢? 我有 6 點建議。
付費限定
在本篇文章中，會分享 3 個適合軟體工程師入門技術寫作的小技巧，以及一些在剛開始撰寫技術文章時可能會遇到的問題及對應心態調整的方式。
「為什麼非產品部門的同事，對產品操作會這麼不熟悉呢？」這是許多產品團隊都可能遭遇的問題。這篇文章分享我在公司舉辦 Workshop (工作坊)的經驗。包含 3 部分：(1) 為什麼要舉辦 Workshop？ (2) 如何準備 Workshop？(3) 我從 Workshop 學到的 3 點經驗教訓
SaaS 公司提供即時、線上的軟體產品/服務，因此讓小白使用者「好上手」是非常重要的。但使用者卡關時怎麼辦？一個不用浪費公司太多人力、又能讓使用者快速排除問題的方法就是：「提供技術文件」。如果你的公司內部/產品團隊沒有專門的Technical Writer，看完這篇文章可以讓你了解 4 種產品必要的
我曾經擔任 PM 將近 6 年的時間、在新職位 - Technical Writer 工作 9 個月的時間，這篇文章分享關於「寫文件」這件事 - 包含 Technical Writer 在做些什麼、跟「產品經理(Product Manager)」的差異。如果你對軟體產業有興趣，一起來看看這篇文章吧。
把技術語言翻譯成大家看得懂的文字，相當不容易啊
