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

選擇您的話題：

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

在知識新鮮時寫作：

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

利用比較：

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

製作引人入勝的介紹：

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

清晰簡潔的標題：

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

Outro的藝術(shù)：

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

增強掃描性：

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

主動的語音和單詞選擇：

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

保持語氣和聲音：

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

管理長度：

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

克服作家的障礙：

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

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

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

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

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

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

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

博客的好處：

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

練習和改進：

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

找到你的聲音：

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

來賓發(fā)布：

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

有用的工具：

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

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