當前位置:首頁 > 嵌入式 > 嵌入式職業(yè)規(guī)劃
[導(dǎo)讀]技術(shù)文章是怎樣煉成的

最近看到很多這方面的文章,我就想了想,我認為的好的技術(shù)文章是什么樣的?這文章主要是寫給自己的,對我以后的技術(shù)文章有警醒作用。

不是讓你在文章開頭寫下,你的文章適合什么樣的人讀?——這是什么意思,鄙視我看不懂你的文章。

我所說的“目標群體”是大家,也包括你自己。你的文章是給大家讀的,也是給自己讀的。

大家能看你的文章,應(yīng)該是我們的榮幸,我們應(yīng)該高興?,F(xiàn)在的互聯(lián)網(wǎng)是個信息大爆炸的時代,什么文章沒有,能看你的文章,有人關(guān)注你,難道你不應(yīng)該慶幸嗎?

如果大家能在看你文章的時候,給你寫評論,那你更應(yīng)該高興,因為人家確實看了你的文章。而且如果給你寫一些建議,那你更應(yīng)該高興不已。因為你得到了意外收獲。

你寫的文章,盡量應(yīng)該簡單,明白。——寫技術(shù)文章,應(yīng)該把復(fù)雜的弄簡單,而不是把簡單的弄復(fù)雜,畢竟不是寫書。

很多“牛人”,很會賣弄風騷,把文章寫的跟舊社會女人的裹腳布一樣,又臭,又長。——有的時候我也經(jīng)常犯這樣的錯誤,雖然我不是”牛人“。

那么怎樣寫的簡單、明了呢?

1、少說廢話,把主題句(關(guān)鍵句)給我們拿出來看就行了,甭寫一堆的廢話。——很多人本來一句話能解釋清楚的事情,用上百行字去讓人明白。這很大程度上也說明他自己也在迷糊中。

2、可以加一些解釋,最多用四句話。——如果超過四句話,說明你還在糊涂中,你就需要“重構(gòu)“了,把內(nèi)容盡量縮短。——畢竟你有時間看,但不要浪費大家的時間。

3、用圖像把主題意思提煉出來。如果你的圖,能說明你的問題,那你就用圖表示,再加一些輔助的文字說明(這是大家不明白的時候才看的)

4、技術(shù)名詞給個連接。——很多人寫文章有個特點,當提到某個技術(shù)的時候,先介紹這個技術(shù)是什么?這用你說嗎?現(xiàn)在的百科,wiki哪一個說的不比你清楚啊,你只需要給個連接就行了。

 

 

[!--empirenews.page--]

你最好把你最主要、最重要的東西往前排。——畢竟不會每個人都看完你的文章。大家都是忙人,還要干別的事呢?哪有心思看完你整片文章。

我記得我想看一些技術(shù)類的書籍的時候,剛開始很興致勃勃的去買了相關(guān)書籍,結(jié)果我看了前兩章,實在沒心思再往后看了,這種書我通常用半年或者一年的時間去看完。畢竟用我辛苦掙得錢買的,如果不看完,心里虧得晃。

但是我發(fā)現(xiàn),很多開始提不起興趣的書,越到后面越讓我來了興致,越到后面越精彩,越到后面我的收獲就越大。——為什么學(xué)點有用的東西就那么難呢?

 

你的文章盡量要簡短。看長長的文章,跟看長函數(shù)一樣,讓人望而生畏。

如果你的文章很長才能說明問題,那我建議你,可以把文章做成系列,分幾個系列給大家看。每次回頭想看的時候,更有針對性。——這就跟我們寫代碼一樣,不要讓你的類太長,如果太長,那你該重構(gòu)了——Extract Class。

 

不要以為你能一下就能把你的文章寫好,你也不是完人,就算是再牛的作家,也還要不停的修改他的文章呢?何況你只是一個coder而已?

我們寫完文章,要經(jīng)常性的翻看自己的文章??次恼碌倪^程,是我們再一次學(xué)習(xí)的過程。翻看的時候,我們自己經(jīng)常能發(fā)現(xiàn)一些問題。如標點符號、錯別字、代碼錯誤、語病、文章樣式...

 

盡量配置一些圖片,很多時候圖片很能說明問題。——如果能配置動畫視頻,那就更爽了。很多時候圖能說明的問題,是文字無法比擬的。

 

不要害怕自己的觀點錯誤,或者技術(shù)錯誤,大膽的寫,如果有人給你指正出來,那你就去找資料去核實下,然后再去改正,這中間你也能學(xué)到很多東西。

不要怕錯誤——勇者無敵嗎!

本站聲明: 本文章由作者或相關(guān)機構(gòu)授權(quán)發(fā)布,目的在于傳遞更多信息,并不代表本站贊同其觀點,本站亦不保證或承諾內(nèi)容真實性等。需要轉(zhuǎn)載請聯(lián)系該專欄作者,如若文章內(nèi)容侵犯您的權(quán)益,請及時聯(lián)系本站刪除。
換一批
延伸閱讀

9月2日消息,不造車的華為或?qū)⒋呱龈蟮莫毥谦F公司,隨著阿維塔和賽力斯的入局,華為引望愈發(fā)顯得引人矚目。

關(guān)鍵字: 阿維塔 塞力斯 華為

加利福尼亞州圣克拉拉縣2024年8月30日 /美通社/ -- 數(shù)字化轉(zhuǎn)型技術(shù)解決方案公司Trianz今天宣布,該公司與Amazon Web Services (AWS)簽訂了...

關(guān)鍵字: AWS AN BSP 數(shù)字化

倫敦2024年8月29日 /美通社/ -- 英國汽車技術(shù)公司SODA.Auto推出其旗艦產(chǎn)品SODA V,這是全球首款涵蓋汽車工程師從創(chuàng)意到認證的所有需求的工具,可用于創(chuàng)建軟件定義汽車。 SODA V工具的開發(fā)耗時1.5...

關(guān)鍵字: 汽車 人工智能 智能驅(qū)動 BSP

北京2024年8月28日 /美通社/ -- 越來越多用戶希望企業(yè)業(yè)務(wù)能7×24不間斷運行,同時企業(yè)卻面臨越來越多業(yè)務(wù)中斷的風險,如企業(yè)系統(tǒng)復(fù)雜性的增加,頻繁的功能更新和發(fā)布等。如何確保業(yè)務(wù)連續(xù)性,提升韌性,成...

關(guān)鍵字: 亞馬遜 解密 控制平面 BSP

8月30日消息,據(jù)媒體報道,騰訊和網(wǎng)易近期正在縮減他們對日本游戲市場的投資。

關(guān)鍵字: 騰訊 編碼器 CPU

8月28日消息,今天上午,2024中國國際大數(shù)據(jù)產(chǎn)業(yè)博覽會開幕式在貴陽舉行,華為董事、質(zhì)量流程IT總裁陶景文發(fā)表了演講。

關(guān)鍵字: 華為 12nm EDA 半導(dǎo)體

8月28日消息,在2024中國國際大數(shù)據(jù)產(chǎn)業(yè)博覽會上,華為常務(wù)董事、華為云CEO張平安發(fā)表演講稱,數(shù)字世界的話語權(quán)最終是由生態(tài)的繁榮決定的。

關(guān)鍵字: 華為 12nm 手機 衛(wèi)星通信

要點: 有效應(yīng)對環(huán)境變化,經(jīng)營業(yè)績穩(wěn)中有升 落實提質(zhì)增效舉措,毛利潤率延續(xù)升勢 戰(zhàn)略布局成效顯著,戰(zhàn)新業(yè)務(wù)引領(lǐng)增長 以科技創(chuàng)新為引領(lǐng),提升企業(yè)核心競爭力 堅持高質(zhì)量發(fā)展策略,塑強核心競爭優(yōu)勢...

關(guān)鍵字: 通信 BSP 電信運營商 數(shù)字經(jīng)濟

北京2024年8月27日 /美通社/ -- 8月21日,由中央廣播電視總臺與中國電影電視技術(shù)學(xué)會聯(lián)合牽頭組建的NVI技術(shù)創(chuàng)新聯(lián)盟在BIRTV2024超高清全產(chǎn)業(yè)鏈發(fā)展研討會上宣布正式成立。 活動現(xiàn)場 NVI技術(shù)創(chuàng)新聯(lián)...

關(guān)鍵字: VI 傳輸協(xié)議 音頻 BSP

北京2024年8月27日 /美通社/ -- 在8月23日舉辦的2024年長三角生態(tài)綠色一體化發(fā)展示范區(qū)聯(lián)合招商會上,軟通動力信息技術(shù)(集團)股份有限公司(以下簡稱"軟通動力")與長三角投資(上海)有限...

關(guān)鍵字: BSP 信息技術(shù)
關(guān)閉
關(guān)閉