Blog Writing Guidelines

Blog Writing Guidelines

語氣與用詞

• 繁體中文，語氣直接輕鬆
• 避免「想像」這類開頭
• 不用「硬編碼」一詞，改用「直接寫在程式碼裡」
• 不要用兜底
• 不要用「你」，多用「我們」
• 中英混雜自然，不用刻意翻譯專有名詞
• 段落簡短，不必前言後語
• 「臺」改用「台」

文章結構

• 開頭直接切入主題
• 段落需要有背景 (包含問題點)、UI/UX 的影響說明、總結、參考資料
• 中間的主要段落需要盡量描述清楚
• 技術細節要保留（程式碼、表格、測試案例都要在）
• 為了讓使用者好讀好懂，多產生圖表，可用 ASCI 畫流程圖或 Markdown 格式表格，也可以條列
• 如果提到相關的部落格文章，在該段落補上 例如 可參考這裡-文章標題
• 範例使用 typescript 撰寫

其他

• 只有當開發者下達指令 “commit and push” 的時候才能執行 commit and push 的動作
• _draft 改寫的文章直接放到 _post 適合的子資料夾
• 要思考跟資料來源相比有什麼需要調整或改善的