關於 technical writing google ，我們在網路上蒐集到這些相關的討論、資訊與評價

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

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

天大好消息！超級雇主Google！越裔高材生的夢想職務！
陳凰鳳老師代發佈Google在台灣徵求越南母語人才訊息：
目前我們預計開啓約莫一年期的 越南語計劃，參與的人員將加入 Google 語音團隊，協助研發工程師建置及發展 "Vietnamese Text-To-Speech at Google"[1][2] 以及 "Vietnamese Automatic Voice Recognition"[3][4]。這些令人興奮的服務不但將能由 Android 手機上直接啓動[2][4] 提供全球使用者使用，還將間接幫助 Google translate[6] 與教學領域的應用[7]。

所以此次徵才欲聘請 Project Manager (1位) 及 Data Evaluator (3位)。
詳細徵才訊息與如下列（您必須有良好的越南母語與外語能力）
有意願者歡迎儘速投出履歷表給我們

有關越南人士工作許可
由於該計劃將於 "臺灣" 或 "新加坡" 進行， 我們將同時考慮應徵者在此兩地的工作許可，
(A) 基本條件:
1. 越南母語人士
2. 語言相關背景，包括語言學、語言教學、翻譯、編輯、校正等等。
(B) 優先條件:
1. 擁有臺灣或新加坡合法工作許可，需能滿足 8 hr/day 和 5 days/week 的工作時數。

(C) 若無工作簽證，須由公司代辦者，需特別註明於履歷表上。
滿足以下兩項條件者，優先考慮：(應政府要求)
1. 有碩士以上學歷。
2. 大學畢業 + 兩年語言相關工作經驗

Job Description as follows:

Speech Data Evaluator:
Job description:
As a Speech Data Evaluator and a native-level speaker of Vietnamese, you will be part of a team processing large amounts of linguistic data and carrying out a number of tasks to improve the quality of Google’s speech synthesis.

This includes:
- Classifying and annotating linguistic data
- Audio evaluation
- Labeling text for disambiguation, expansion, and text normalization
- Providing phonetic transcription of lexicon entries according to given standards and using in-house tools

Job requirements:
- Native-level speaker of Vietnamese (with good command of the standard dialect) and fluent in English
- Passion for language with good knowledge of orthography and grammar in the target language
- A degree in a language-related field such as linguistics, language teaching, translation, editing, writing, proofreading, or similar
- Keen interest in technology and computer-literate (should feel comfortable using in-house tools and should have an interest in current speech, mobile and online technology)
- Attention to detail and good organizational skills

Project duration: 6-11 months (with potential for extension)
**This is not a permanent position but a contract position through an employment agency. Applicants better are currently authorized to work in Taiwan. Please add a special note if you don't have working permission in Taiwan. Please add a special note if you don't have working permission in Taiwan.**
For immediate consideration, please email your CV and cover letter in English (PDF format preferred) with "Speech Data Evaluator " in the subject line.

Application Deadline: (Open until filled)
Email Address for Applications: meiyu@google.com
------------------------

Speech Linguistic Project Manager

As a Linguistic Project Manager and a native-level speaker of Vietnamese, you will oversee and manage all work related to achieving high data quality for speech projects in your own language.
You will be based in London, managing a team of Speech Data Evaluators and working on a number of projects towards TTS synthesis.
This includes:
- Training, managing and overseeing the work of your team
- Creating verbalisation rules, such as expanding URLs, email addresses, numbers
- Creating annotation conventions
- Evaluating data quality
- Providing expertise on pronunciation and phonotactics
- Working with QA tools according to given guidelines and using in-house tools
Job requirements:
- Native-level speaker of Vietnamese (with good command of the standard dialect) and fluent in English
- Must have attended elementary school in the country where the language is spoken
- Keen ear for phonetic nuances and attention to detail; knowledge of the language’s phonology
- Ability to quickly grasp technical concepts; should have an -interest in current speech, mobile, and online technology
- Excellent oral and written communication skills
- Good organizational skills
- Previous project management and people management experience
- Previous experience with speech/NLP-related projects a plus
- Advanced degree in Linguistics preferred; experience with Computational Linguistics a plus
- Also a plus: proficiency with HTML, XML, and some programming language; previous experience working in a Linux environment
Project duration: 6-11 months (with potential for extension)
**This is not a permanent position but a contract position through an employment agency. Applicants better are currently authorized to work in Taiwan.**
For immediate consideration, please email your CV and cover letter in English (PDF format preferred) with “Speech Linguistic Project Manager ” in the subject line.

Email Address for applications: mailto:tts_jobs@google.com
========================================================
Reference:
Google text-to-speech
[1] http://en.wikipedia.org/wiki/Google_Text-to-Speech
[2] https://play.google.com/store/apps/details?id=com.google.android.tts
Google voice search
[3] http://en.wikipedia.org/wiki/Google_Voice_Search
[4] https://play.google.com/store/apps/details?id=com.google.android.voicesearch
Google translate:
[5] http://en.wikipedia.org/wiki/Google_Translate
[6] https://translate.google.com/
Application in education:
[7] http://www.freetech4teachers.com/2011/09/speak-it-text-to-speech-in-google.html#.VQZ7KHV7jUa
========================================================