本指南彙編了有關(guān)技術(shù)寫作的建議和見解，尤其是對於網(wǎng)絡(luò)技術(shù)和博客，是從經(jīng)驗(yàn)豐富的專業(yè)人員和個(gè)人經(jīng)驗(yàn)中汲取的。

選擇您的話題：

理想的話題是您熱衷和個(gè)人投入的話題。您的熱情將散發(fā)出來。正如克里斯·科伊爾（Chris Coyier）明智地建議：“寫一篇文章，希望在您搜索某些東西時(shí)找到您的文章。”雖然基於任務(wù)的寫作可能是有效的，但個(gè)人聯(lián)繫會(huì)提高質(zhì)量。

在知識(shí)新鮮時(shí)寫作：

最好的寫作時(shí)間是在學(xué)習(xí)新知識(shí)之後立即。體驗(yàn)仍然是生動(dòng)的，使您可以傳達(dá)“之前”和“之後”的理解。即使記下有關(guān)學(xué)習(xí)過程的快速記錄，以後也可能很有價(jià)值。考慮到曼努埃爾·馬圖佐維奇（Manuel Matuzovic）舉例說明的“今天我學(xué)到的”方法。

利用比較：

一種強(qiáng)大的，未充分利用的技術(shù)正在將新技術(shù)與熟悉的技術(shù)進(jìn)行比較。雷切爾·安德魯（Rachel Andrew）建議向熟悉JQuery的人解釋現(xiàn)代JavaScript技術(shù)，並彌合了新的和已知的差距。這種方法將陌生的基礎(chǔ)聯(lián)繫起來。

製作引人入勝的介紹：

一個(gè)共同的陷阱未能清楚地陳述文章的目的，並儘早瞄準(zhǔn)受眾。雷切爾·安德魯（Rachel Andrew）強(qiáng)調(diào)了簡潔介紹的重要性，該簡潔介紹立即闡明了主題並打算讀者。布萊恩·里納爾迪（Brian Rinaldi）補(bǔ)充說，寫得很好的介紹性段落可以確定讀者是否繼續(xù)。

清晰簡潔的標(biāo)題：

Erin Kissane倡導(dǎo)清晰的描述性標(biāo)題，優(yōu)先考慮清晰的清晰性。諸如“從GraphQl，Phoenix和React開始入門”之類的明確標(biāo)題要優(yōu)於模糊的Clickbaity。清晰度有益於讀者理解和SEO。

Outro的藝術(shù)：

本·哈珀恩（Ben Halpern）強(qiáng)調(diào)了結(jié)論段落的重要性，這通常是引言後的第二讀部分。雖然簡單的摘要（“告訴'em你告訴你的'em”是有效的，但精心製作的結(jié)論加強(qiáng)了信息並提供了封閉。

增強(qiáng)掃描性：

Brian Rinaldi強(qiáng)調(diào)了分解大量文本以提高可讀性的重要性。技術(shù)包括使用子標(biāo)題，列表，相關(guān)圖像和屏幕截圖，說明性圖形，簡潔視頻，良好的代碼塊，表格和可折疊<details>/<summary></summary></details>截面<details>/<summary></summary></details> 。諸如間距，顏色和對齊方式之類的設(shè)計(jì)元素的戰(zhàn)略使用進(jìn)一步提高了掃描性。

主動(dòng)的語音和單詞選擇：

Katy Decorah和Neal Whitman強(qiáng)調(diào)使用活動(dòng)語音（“服務(wù)器處理請求”）而不是被動(dòng)語態(tài)（“請求是由服務(wù)器處理”）。避免諸如“ Just”之類的詞，這可能是屈尊的，通常是不必要的。

保持語氣和聲音：

音調(diào)（您怎麼說）應(yīng)該與上下文保持一致。友好，權(quán)威，熱情和感恩的語氣通常適合技術(shù)寫作。即使在調(diào)整不同情況下的語氣時(shí)，聲音（您的個(gè)性）也應(yīng)保持一致。

管理長度：

技術(shù)寫作通常遭受過多的長度。韋德·克里斯滕森（Wade Christensen）建議採用殘酷的編輯方法。雖然太短的帖子也有問題，但清晰度和有用性應(yīng)該是主要重點(diǎn)，而不是單詞計(jì)數(shù)。只有在零件在主題上是獨(dú)特且獨(dú)立的，才能將長篇文章分為一個(gè)系列。

克服作家的障礙：

恐懼和自我懷疑是技術(shù)博客的常見障礙。馬克斯·伯克（MaxB?ck）建議一旦涵蓋了基本要點(diǎn)，就會(huì)忽略“尚未準(zhǔn)備就緒”的聲音。傑里米·基思（Jeremy Keith）建議不要保留選秀，因?yàn)樗鼈兺ǔ＿€沒有完成。請記住，即使是小貢獻(xiàn)也可能有幫助（Matthias Ott）。阿里·斯皮特爾（Ali Spittel）指出，即使是初學(xué)者也有寶貴的觀點(diǎn)。

風(fēng)格和創(chuàng)造力：

薩拉·索伊丹（Sara Soueidan）強(qiáng)調(diào)，沒有一個(gè)完美的寫作風(fēng)格。做你自己，讓你的個(gè)性在保持清晰度的同時(shí)發(fā)光。嘗試創(chuàng)意格式，例如帶註釋的對話或視頻系列。

以初學(xué)者為中心的內(nèi)容：

儘管網(wǎng)絡(luò)充滿了初學(xué)者級(jí)內(nèi)容，但寫得很好的介紹性文章可以脫穎而出。清晰度對於所有技能水平都是有價(jià)值的。

現(xiàn)實(shí)世界的例子與抽象：

克里斯?。–hristine）強(qiáng)調(diào)了現(xiàn)實(shí)世界中的重要性來說明復(fù)雜的概念。但是，避免損害清晰度的例子。當(dāng)有效使用時(shí)，抽象可以很大。

博客的好處：

博客可以增強(qiáng)職業(yè)前景，展示專業(yè)知識(shí)並提高理解。 Khoi Vinh將博客描述為“放大器”。

練習(xí)和改進(jìn)：

一致的寫作和出版對於改進(jìn)至關(guān)重要。 “用賭注寫作”（公開分享您的工作）是最有效的學(xué)習(xí)方法。

找到你的聲音：

首先簡單地分享您的知識(shí)。通過結(jié)合個(gè)人經(jīng)驗(yàn)，引用他人並進(jìn)行研究來增強(qiáng)您的寫作。

來賓發(fā)布：

如果投放到網(wǎng)站，請仔細(xì)審查其準(zhǔn)則。

有用的工具：

建議使用用於協(xié)作的Dropbox紙和用於校對的語法工具。

以上是技術(shù)寫作建議的詳細(xì)內(nèi)容。更多資訊請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！