前言
? ? 我最近喜歡把寫的十分優(yōu)美的技術(shù)文章叫做安利文养晋。首先囊拜,文章必須是原創(chuàng)而非軟廣俱恶;其次兔港,閱讀之后不僅能快速吸納技術(shù)要點(diǎn)并入門開發(fā)庸毫,還能感同身受的體會(huì)作者熱情洋溢的贊美和急于分享心得體驗(yàn)的心情,讓人感覺相見恨晚衫樊,醍醐灌頂飒赃。
? ? 安利文基于技術(shù)文章但又高于技術(shù)文章,同是經(jīng)驗(yàn)總結(jié)科侈,但卻因?yàn)樽髡哒J(rèn)真的揣摩每一個(gè)標(biāo)點(diǎn)载佳、斷句而變得優(yōu)雅。一篇滿是主觀感受的文章卻不嚼之乏味臀栈,作者用心的指出每一個(gè)需要注意的技術(shù)亮點(diǎn)在文字中如蛟龍戲水蔫慧,讓閱讀者大呼過癮。因此权薯,我覺得能原創(chuàng)分享一篇技術(shù)文章精神已經(jīng)難能可貴姑躲,但若能錦上添花讓技術(shù)文章變得優(yōu)雅睡扬,那實(shí)乃萬全之事,功德之記黍析。
? ? 贖我能力有限卖怜,無法筆下生花,恰巧前天在做一個(gè)Android項(xiàng)目的時(shí)候從github無意覓得sugar這個(gè)棒極了的ORM庫阐枣。難忍手癢望安利之马靠,因此擺弄一下筆墨,一方面說說我覺得程序員該如何寫一篇優(yōu)雅的安利文蔼两,一方面讓大家知道這個(gè)真心棒呆了的庫甩鳄。
何為安利文
? ? ”安利文“是網(wǎng)絡(luò)詞匯,只要非標(biāo)準(zhǔn)化協(xié)議的定義额划,都是一件很主觀的東西娩贷,我認(rèn)為安利文應(yīng)該具備的條件包括:
1.開源。只有開源產(chǎn)品才會(huì)讓人硬起來锁孟,不代表竭澤而漁的獲取,而是只有愛的人才會(huì)明白的一種精神(我水平低只有個(gè)star200多的開源項(xiàng)目茁瘦,但我覺得很開心)品抽。
2.原創(chuàng)。哪怕是譯文甜熔,也應(yīng)加入自己的主觀體驗(yàn)圆恤。因?yàn)橹挥小皩?shí)踐是檢驗(yàn)真理的唯一工具”,若未親身嘗試何談贊美一說腔稀。
3.文章干凈利索盆昙。1..2..3簡(jiǎn)單明了的說明怎么用,4..5..6直接了當(dāng)?shù)恼f明技術(shù)亮點(diǎn)焊虏。不要從“今天坐地鐵遇上個(gè)黑絲大波妹”開始淡喜,"這個(gè)項(xiàng)目做完老板加班費(fèi)都不給"結(jié)尾,只談技術(shù)诵闭。
4.有領(lǐng)域經(jīng)驗(yàn)炼团,有自己的見地,能一針見血的指出安利對(duì)象讓人愛不釋手的理由疏尿。閱讀者不乏入門開發(fā)者瘟芝,若沒有起碼2個(gè)以上的項(xiàng)目經(jīng)驗(yàn),拿著一個(gè)自己用過的東西就瘋狂的寫上我愛它褥琐,但有其他更優(yōu)秀的輪子能替代锌俱,若無人評(píng)論中指出,豈不貽人之時(shí)敌呈。
5.毫不掩飾自己的喜悅之情贸宏。若你對(duì)自己推薦的輪子沒有信心造寝,那如何向其他人證明這確實(shí)就是右轉(zhuǎn)就再永遠(yuǎn)錯(cuò)過的佳作?根本不用左的保守表達(dá)來訴說你運(yùn)用過程中體會(huì)到的興奮锚赤、快感匹舞,就是應(yīng)該讓閱讀者感同身受。
如何優(yōu)雅的寫
? ? “優(yōu)雅”一詞我見于技術(shù)類文章线脚,最早是在學(xué)習(xí)laravel文檔的時(shí)候看到的赐稽。看過文檔的人態(tài)度非常兩極:愛的不要不要的和罵的不要不要的浑侥。我非常理解為何會(huì)有人罵姊舵,讀laravel文檔的心態(tài)和受MSDN傳統(tǒng)教育刻板挑錯(cuò)別字的閱讀心態(tài)完全不同:讀起來感覺很輕,措辭用起來像軟廣寓落。說一個(gè)開源項(xiàng)目發(fā)軟廣括丁,肯定是門戶之爭(zhēng)、輪子忠誠的事伶选,但這也算安利文的樂趣和精華之一史飞,從評(píng)論中可以了解更多的經(jīng)驗(yàn)教訓(xùn),而這些都是建立在大拿們無私分享經(jīng)驗(yàn)基礎(chǔ)上的仰税。因此构资,“優(yōu)雅”的寫,引發(fā)一場(chǎng)爭(zhēng)論陨簇,反而是一件值得慶幸的事吐绵。
? ? “優(yōu)雅”帶有很強(qiáng)烈的資產(chǎn)階級(jí)文藝小資派氣息,要習(xí)慣裝的像個(gè)文青河绽,大膽“優(yōu)雅”的去寫安利文己单。下面,我說說我認(rèn)為應(yīng)該如何優(yōu)雅的寫:
1.讀起來像機(jī)翻耙饰∥屏“令人激動(dòng)的新特性”、“可能是XXX”榔幸、“值得去深入探究”允乐、“超乎想象的極致”...,是不是很眼熟削咆?細(xì)思肉麻牍疏,讀來上口。用這些科技公司的廣告語拨齐,總是比打開搜索引擎賣弄唐詩更實(shí)在的選擇鳞陨,因?yàn)殡m然辭藻談不上華麗,但卻最容易讓開發(fā)人員感同身受,畢竟習(xí)慣了譯文的句式和用詞厦滤。當(dāng)然如果你能寫出羅貫中的筆鋒來援岩,中文科技博客就該辦個(gè)作協(xié)了。
2.一個(gè)自然段不宜過長(zhǎng)掏导。想表達(dá)的東西很多享怀,很好,但你可以分為多個(gè)自然段趟咆。過長(zhǎng)的自然段可能會(huì)降低閱讀者的閱讀興趣添瓷,其實(shí)這很不好,與其說是用戶體驗(yàn)優(yōu)化值纱,不如說是讓人變懶了鳞贷,不應(yīng)該適用于開發(fā)人員。
3.圖虐唠。一圖頂百字搀愧,用Visio、XMind疆偿、UML畫咱筛,太懶了QQ截屏也是不錯(cuò)的選擇。
4.善用括號(hào)加強(qiáng)主觀態(tài)度(就像這樣杆故,你看這里就像是和我在交心眷蚓,討厭-_-!!)。把你在描述技術(shù)點(diǎn)時(shí)的心得體會(huì)寫進(jìn)括號(hào)反番,閱讀者能夠體會(huì)到更強(qiáng)烈的主觀印象。
5.代碼處理好細(xì)節(jié)叉钥。必須格式化罢缸,markdown或者博客編輯器自帶的格式化工具,沒人會(huì)喜歡沒有縮進(jìn)的代碼投队。盡量豐富的添加備注枫疆,這會(huì)讓閱讀者感動(dòng)。
6.標(biāo)題敷鸦、小標(biāo)題息楔、加粗。這是讓文章寫作更簡(jiǎn)單的一件事扒披,而不是加重你的寫作負(fù)擔(dān)值依。因?yàn)槟闶抢砜粕@更符合你的思維邏輯碟案。如果不知道如何措辭愿险,就像我這樣用小標(biāo)題1..2..3分段吧,不需要css裝飾价说,其他開發(fā)人員會(huì)看明白的辆亏。
7.善意的吹牛逼风秤。這會(huì)提高閱讀者的心理“錨點(diǎn)”,就是“星巴克的拿鐵賣的就必須比肯德基貴”的道理扮叨,善意的吹吹牛逼是你在表明自己對(duì)輪子忠誠度的方式缤弦,比如我就從不用dagger或者butterKnife,我公司項(xiàng)目全都是剪切加復(fù)制彻磁,也沒見上線運(yùn)行出問題(看明白了碍沐?)。
8.謙虛謹(jǐn)慎的自信兵迅,恍恍惚惚的放屁抢韭。天外有天,人外有人恍箭,誰一夜看得完萬卷書刻恭,一碗吃得下千斤飯。千萬不可自驕自傲扯夭,應(yīng)該虛心接受評(píng)論里的指正鳍贾,心態(tài)很有必要。但是交洗,為了提高閱讀者的閱讀興趣骑科,插科打諢、睜著眼放屁构拳,出現(xiàn)“5成的把握它會(huì)是Github上最棒的項(xiàng)目咆爽,5成的把握它會(huì)是Github上最爛的項(xiàng)目”,這種完全無意義的文字置森,是完全鼓勵(lì)的一種行為斗埂。
9.放入草稿箱,喝杯茶再打開修改一遍凫海。最后一點(diǎn)請(qǐng)記住呛凶,你是想寫一篇引起共鳴的安利文,而不是一般的技術(shù)總結(jié)行贪,所以重構(gòu)是非常有必要的漾稀。
? ? 想到些什么,就即興寫了建瘫,其實(shí)我也是在為自己練筆崭捍,勤能補(bǔ)拙。本來還想安利一下我微博喜歡閱讀的幾個(gè)科技號(hào)啰脚,但有沾人家地氣的嫌疑缕贡,看我經(jīng)常轉(zhuǎn)發(fā)的微博就知道是哪些了。如果讓你有了第二天自己寫一篇安利文的沖動(dòng),也算這篇文章沒有白寫晾咪。下一篇是自己練習(xí)寫的安利文例子收擦,希望大家喜歡。
歡迎隨手微博@慧積木合谍倦,或者關(guān)注微信公眾號(hào)『懶文』(有認(rèn)證那個(gè))塞赂,或者加App獨(dú)立開發(fā)群? 『533838427』(找不到風(fēng)投只好借個(gè)地方介紹下自己的社交賬號(hào),我準(zhǔn)備倒騰個(gè)不僅能扯蛋昼蛀,還能把扯的蛋做成APP宴猾,還能把APP可能不會(huì)丟臉的代碼拿來開源的科技類公眾號(hào)。嗯嗯叼旋,我是個(gè)半吊子恰好稍微ios仇哆、android、php夫植、.net讹剔、公眾號(hào)、前端详民、設(shè)計(jì)都會(huì)點(diǎn)的Uber司機(jī))延欠。