寫在前面
你的產(chǎn)品有多好并不重要。因?yàn)槿绻渖狭艘环輼O其敷衍的文檔（Documentation），人們就不會(huì)使用它。 這話聽(tīng)起來(lái)可能有些絕對(duì)，畢竟在別無(wú)選擇的時(shí)候，用戶或許會(huì)試著使用你的產(chǎn)品來(lái)解決他們的燃眉之急。 但這種情況下，很難假設(shè)用戶會(huì)按照預(yù)期去使用你的產(chǎn)品，要求做到高效率的使用，則更是一種奢望。
幾乎每個(gè)人都明白這一點(diǎn)。幾乎每個(gè)人都知道他們需要好的文檔，而且大多數(shù)人都試圖創(chuàng)建好的文檔。而寫作風(fēng)格指南可以確保一個(gè)團(tuán)隊(duì)寫出來(lái)的文檔是一致的。
寫作風(fēng)格指南清單
下面，整理了一些技術(shù)文檔的寫作指南與大家分享，希望每一份優(yōu)秀的產(chǎn)品都有一份比之更優(yōu)秀的文檔。
谷歌開(kāi)發(fā)者文檔風(fēng)格指南：https://developers.google.cn/style
蘋果風(fēng)格指南：https://help.apple.com/asg/
微軟寫作風(fēng)格指南：https://docs.microsoft.com/en-us/style-guide/welcome/
-
芝加哥手冊(cè)指南：https://www.chicagomanualofstyle.org/
IBM 風(fēng)格指南：https://www.ibm.com/developerworks/library/styleguidelines/index.html
Kubernetes 文檔風(fēng)格指南：https://kubernetes.io/docs/contribute/style/style-guide/
NLM 面向作者、編輯和出版商的風(fēng)格指南：https://www.ncbi.nlm.nih.gov/books/NBK7256/?depth=2
牛津大學(xué)風(fēng)格指南：https://www.ox.ac.uk/sites/files/oxford/media_wysiwyg/University%20of%20Oxford%20Style%20Guide.pdf
-
中文技術(shù)文檔寫作風(fēng)格指南：https://zh-style-guide.readthedocs.io/zh_CN/latest/index.html
說(shuō)明：
前 8 個(gè)都為英文版風(fēng)格指南，只有最后一個(gè)為中文，個(gè)人也比較喜歡，其 Github 地址為 https://github.com/yikeke/zh-style-guide
寫在后面
在小型創(chuàng)業(yè)公司，倒也沒(méi)有寫作風(fēng)格指南這么一說(shuō)，因?yàn)榧夹g(shù)寫作的也就幾個(gè)人，寫作風(fēng)格完全自由。個(gè)人認(rèn)為，如果是參與團(tuán)隊(duì)技術(shù)寫作時(shí)，制定并遵循寫作風(fēng)格指南是完全必要的，以便給用戶帶來(lái)更好的信息體驗(yàn)。
