今天的文章不是一個技術文，反而是探討身為一個軟體工程師，該怎麼撰寫相關的技術文件
鑑於 WFH (Work From Hoem) 習慣的興起，人與人面對面的溝通減少，這意味即時的訊息傳遞變少了，取而代之的是非同步的訊息傳遞，簡單來說就是技術文件。
好的技術文件能夠讓需要的人快速找到問題，解決疑惑，但是一個好的技術文件到底該怎麼寫，這部分其實非常困難，並不是向程式碼一樣可以 copy&paste 馬上看到成果的，反而是需要時間練習，將整個過程與思路消化起來，用自己習慣的語言與形式將其撰寫出來。
首先，作者非常推崇由 Google 撰寫的系列文章，Tech Writing Course，整個課程內容不到兩小時，從不同章節來跟大家分享如何撰寫技術文章
接者撰寫技術文章時，作者個人是喜歡 divio 這個平台，不過更重要的則是其推薦的分類模式，根據內容分類成四大項
1. Tutorials - 學習導向
2. How-To Guides - 問題解決導向
3. Explanation - 深度理解導向
4. Reference - 資運分享導向
Google: https://developers.google.com/tech-writing
Divio: https://www.divio.com/
最後寫作語法方面，作者認為寫出一個能夠被有效搜尋的文章是非常重要的，譬如透過 word 等方式上傳檔案到系統中反而是一個不利於搜尋的方式。
取而代之的是，作者認為可以採用 Markdown 類似的語法作為基礎去撰寫文章，這種方式對於維護與撰寫都相對容易
今天有任何 Diagrams 的畫圖需求，可以考慮使用 Mermaid 這套解決方案，對於 GitLab/Azure 的使用者來說，已經內建其中。 GitHub/Atlassian Confluence 則有相關的 Plugin 可以安裝使用
最後則是文章的樣版內容，針對特定的文章格式，已經有不少的範本可以參考，透過這些範本可以更清楚的去描述你的內容，讓整體文章看起來更佳簡潔與流暢
1. Software Architecture Review Template
2. Architecture Decision Record Template
3. Incident Postmortem Template
4. DevOps Runbook
5. Decision Template
6. Writing Guidelines
7. OKR Template
8. Etc.
有興趣的點選原文學習更多
https://medium.com/better-programming/best-practices-when-documenting-your-code-for-software-engineers-941f0897aa0
github上傳檔案 在 [疑惑] 檔案上傳github之後不見了- 看板Ladies_Digi 的推薦與評價
大家好，小妹剛剛在寫網頁作業，好不容易終於寫好了，
因為老師要求所以上傳github，
這邊有段題外話(不過我不知道會不會其實是重點)
前兩個禮拜也是要上傳github不過一直遇到問題，
網頁版的找不到上傳檔案的按鈕(已解決，後來有發現是少勾東西)
所以我有下載桌面版github，
不過一直上傳失敗，不斷的顯示fail to clone的訊息。
所以上次其實我是用別人的電腦傳的。
題外話結束。
按照前例，我又試了一次桌面版，然後又失敗了，
改用網頁版時又遇到無法直接把資料夾拖曳進上傳框的問題，
不過沒多久發現只要點出瀏覽視窗就可以把資料夾拖進去，
把圖片跟css檔都commit上去，只差最後一個就大功告成，
卻發現我的html檔不見了啊啊啊啊啊!!!!!
雖然我執行的網頁還開著所以原始碼都還在，
可是這種事情還是讓我很驚恐啊!
我去資源回收桶看，也用執行找，
真的都找不到本來那個檔案，
想來想去也只可能是失敗的github那邊出了什麼問題吧?
但其實我又覺得那也很不可能啊!
所以想請問版上的各位，
是否有遇過相同的狀況，
原檔案可能會是去哪裡了呢?
說明有點長，謝謝大家!!!
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 218.35.136.214
※ 文章網址: https://www.ptt.cc/bbs/Ladies_Digi/M.1459460826.A.001.html
... <看更多>