如何優(yōu)雅的寫一篇安利文

前言

? ? 我最近喜歡把寫的十分優(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í)乃萬全之事,功德之記黍析。

Sugar ORM

? ? 贖我能力有限卖怜,無法筆下生花,恰巧前天在做一個(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.虐唠。一圖頂百字搀愧,用VisioXMind疆偿、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ī))延欠。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市沈跨,隨后出現(xiàn)的幾起案子由捎,更是在濱河造成了極大的恐慌,老刑警劉巖饿凛,帶你破解...
    沈念sama閱讀 206,311評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件狞玛,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡涧窒,警方通過查閱死者的電腦和手機(jī)为居,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來杀狡,“玉大人,你說我怎么就攤上這事贰镣∥叵螅” “怎么了?”我有些...
    開封第一講書人閱讀 152,671評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵碑隆,是天一觀的道長(zhǎng)恭陡。 經(jīng)常有香客問我,道長(zhǎng)上煤,這世上最難降的妖魔是什么休玩? 我笑而不...
    開封第一講書人閱讀 55,252評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上拴疤,老公的妹妹穿的比我還像新娘永部。我一直安慰自己,他們只是感情好呐矾,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,253評(píng)論 5 371
  • 文/花漫 我一把揭開白布苔埋。 她就那樣靜靜地躺著,像睡著了一般蜒犯。 火紅的嫁衣襯著肌膚如雪组橄。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,031評(píng)論 1 285
  • 那天罚随,我揣著相機(jī)與錄音玉工,去河邊找鬼。 笑死淘菩,一個(gè)胖子當(dāng)著我的面吹牛遵班,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播瞄勾,決...
    沈念sama閱讀 38,340評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼费奸,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了进陡?” 一聲冷哼從身側(cè)響起愿阐,我...
    開封第一講書人閱讀 36,973評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎趾疚,沒想到半個(gè)月后缨历,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,466評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡糙麦,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,937評(píng)論 2 323
  • 正文 我和宋清朗相戀三年辛孵,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片赡磅。...
    茶點(diǎn)故事閱讀 38,039評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡魄缚,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出焚廊,到底是詐尸還是另有隱情冶匹,我是刑警寧澤,帶...
    沈念sama閱讀 33,701評(píng)論 4 323
  • 正文 年R本政府宣布咆瘟,位于F島的核電站嚼隘,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏袒餐。R本人自食惡果不足惜飞蛹,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,254評(píng)論 3 307
  • 文/蒙蒙 一谤狡、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧卧檐,春花似錦墓懂、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至佛嬉,卻和暖如春逻澳,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背暖呕。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來泰國打工斜做, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人湾揽。 一個(gè)月前我還...
    沈念sama閱讀 45,497評(píng)論 2 354
  • 正文 我出身青樓瓤逼,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國和親库物。 傳聞我的和親對(duì)象是個(gè)殘疾皇子霸旗,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,786評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容