今天的文章不是一個技術文，反而是探討身為一個軟體工程師，該怎麼撰寫相關的技術文件

鑑於 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

[#資源推介] [#初中英語] 各位同學，不妨看看這套電影trailer，看看裡面的英語，你聽得懂多少？我在下面寫了transcript，自己嘗試了之後可以對照，看看自己聽得懂多少喔！雖然詞彙都很簡單，但要對語法和字的讀音熟悉到聽得懂也絕對不簡單哦！

https://www.youtube.com/watch?v=TQMqvG4t3Mo

TRANSCRIPT:
I am going to tell you a story about a boy who would never grow up. About the pirate who wished to catch him. About an island where fairies roam. But this isn’t a story which you have heard before. Because sometimes friends begin as enemies and enemies begin as friends. Sometimes to truly understand how things end, we must first know how they begin.

Welcome to Neverland.

Be brave, Peter.

I try to be.

There’s an ancient prophecy which says fairy kingdom reigns in this land. It tells of a boy who leads an uprising against me. A boy who could fly.

I will be darned.

Hurry. You have to get us off this island.

If that boy makes it to the natives, all will be lost.

We have been waiting for you, Peter.

Black Beard won’t stop searching.

There’s only a place he wouldn’t dare look.

So pirates are afraid of mermaid lagoon?

Because of crocodiles.

Afraid?

It was written when you return you unite our people against the pirates.

Mind if I cut in?

What if I failed to fulfill the prophecy

What if you failed to try?

If you don’t believe, then neither will they.

You can’t stay a kid forever, even in Neverland.

Now kneel.

I will never bow to you.

Do you know how to work a ship?

How hard could it be?

This is a lot harder than it looks.

We’re sailing now.