如何優雅的寫一篇安利文

前言

? ? 我最近喜歡把寫的十分優美的技術文章叫做安利文。首先,文章必須是原創而非軟廣;其次,閱讀之后不僅能快速吸納技術要點并入門開發,還能感同身受的體會作者熱情洋溢的贊美和急于分享心得體驗的心情,讓人感覺相見恨晚,醍醐灌頂。

? ? 安利文基于技術文章但又高于技術文章,同是經驗總結,但卻因為作者認真的揣摩每一個標點、斷句而變得優雅。一篇滿是主觀感受的文章卻不嚼之乏味,作者用心的指出每一個需要注意的技術亮點在文字中如蛟龍戲水,讓閱讀者大呼過癮。因此,我覺得能原創分享一篇技術文章精神已經難能可貴,但若能錦上添花讓技術文章變得優雅,那實乃萬全之事,功德之記。

Sugar ORM

? ? 贖我能力有限,無法筆下生花,恰巧前天在做一個Android項目的時候從github無意覓得sugar這個棒極了的ORM庫。難忍手癢望安利之,因此擺弄一下筆墨,一方面說說我覺得程序員該如何寫一篇優雅的安利文,一方面讓大家知道這個真心棒呆了的庫。

何為安利文

? ? ”安利文“是網絡詞匯,只要非標準化協議的定義,都是一件很主觀的東西,我認為安利文應該具備的條件包括:

1.開源。只有開源產品才會讓人硬起來,不代表竭澤而漁的獲取,而是只有愛的人才會明白的一種精神(我水平低只有個star200多的開源項目,但我覺得很開心)。

2.原創。哪怕是譯文,也應加入自己的主觀體驗。因為只有“實踐是檢驗真理的唯一工具”,若未親身嘗試何談贊美一說。

3.文章干凈利索。1..2..3簡單明了的說明怎么用,4..5..6直接了當的說明技術亮點。不要從“今天坐地鐵遇上個黑絲大波妹”開始,"這個項目做完老板加班費都不給"結尾,只談技術。

4.有領域經驗,有自己的見地,能一針見血的指出安利對象讓人愛不釋手的理由。閱讀者不乏入門開發者,若沒有起碼2個以上的項目經驗,拿著一個自己用過的東西就瘋狂的寫上我愛它,但有其他更優秀的輪子能替代,若無人評論中指出,豈不貽人之時。

5.毫不掩飾自己的喜悅之情。若你對自己推薦的輪子沒有信心,那如何向其他人證明這確實就是右轉就再永遠錯過的佳作?根本不用左的保守表達來訴說你運用過程中體會到的興奮、快感,就是應該讓閱讀者感同身受。

如何優雅的寫

? ? “優雅”一詞我見于技術類文章,最早是在學習laravel文檔的時候看到的。看過文檔的人態度非常兩極:愛的不要不要的和罵的不要不要的。我非常理解為何會有人罵,讀laravel文檔的心態和受MSDN傳統教育刻板挑錯別字的閱讀心態完全不同:讀起來感覺很輕,措辭用起來像軟廣。說一個開源項目發軟廣,肯定是門戶之爭、輪子忠誠的事,但這也算安利文的樂趣和精華之一,從評論中可以了解更多的經驗教訓,而這些都是建立在大拿們無私分享經驗基礎上的。因此,“優雅”的寫,引發一場爭論,反而是一件值得慶幸的事。

? ? “優雅”帶有很強烈的資產階級文藝小資派氣息,要習慣裝的像個文青,大膽“優雅”的去寫安利文。下面,我說說我認為應該如何優雅的寫:

1.讀起來像機翻。“令人激動的新特性”、“可能是XXX”、“值得去深入探究”、“超乎想象的極致”...,是不是很眼熟?細思肉麻,讀來上口。用這些科技公司的廣告語,總是比打開搜索引擎賣弄唐詩更實在的選擇,因為雖然辭藻談不上華麗,但卻最容易讓開發人員感同身受,畢竟習慣了譯文的句式和用詞。當然如果你能寫出羅貫中的筆鋒來,中文科技博客就該辦個作協了。

2.一個自然段不宜過長。想表達的東西很多,很好,但你可以分為多個自然段。過長的自然段可能會降低閱讀者的閱讀興趣,其實這很不好,與其說是用戶體驗優化,不如說是讓人變懶了,不應該適用于開發人員。

3.。一圖頂百字,用VisioXMindUML畫,太懶了QQ截屏也是不錯的選擇。

4.善用括號加強主觀態度(就像這樣,你看這里就像是和我在交心,討厭-_-!!)。把你在描述技術點時的心得體會寫進括號,閱讀者能夠體會到更強烈的主觀印象。

5.代碼處理好細節。必須格式化,markdown或者博客編輯器自帶的格式化工具,沒人會喜歡沒有縮進的代碼。盡量豐富的添加備注,這會讓閱讀者感動。

6.標題、小標題、加粗。這是讓文章寫作更簡單的一件事,而不是加重你的寫作負擔。因為你是理科生,這更符合你的思維邏輯。如果不知道如何措辭,就像我這樣用小標題1..2..3分段吧,不需要css裝飾,其他開發人員會看明白的。

7.善意的吹牛逼。這會提高閱讀者的心理“錨點”,就是“星巴克的拿鐵賣的就必須比肯德基貴”的道理,善意的吹吹牛逼是你在表明自己對輪子忠誠度的方式,比如我就從不用dagger或者butterKnife,我公司項目全都是剪切加復制,也沒見上線運行出問題(看明白了?)。

8.謙虛謹慎的自信,恍恍惚惚的放屁。天外有天,人外有人,誰一夜看得完萬卷書,一碗吃得下千斤飯。千萬不可自驕自傲,應該虛心接受評論里的指正,心態很有必要。但是,為了提高閱讀者的閱讀興趣,插科打諢、睜著眼放屁,出現“5成的把握它會是Github上最棒的項目,5成的把握它會是Github上最爛的項目”,這種完全無意義的文字,是完全鼓勵的一種行為。

9.放入草稿箱,喝杯茶再打開修改一遍。最后一點請記住,你是想寫一篇引起共鳴的安利文,而不是一般的技術總結,所以重構是非常有必要的。

? ? 想到些什么,就即興寫了,其實我也是在為自己練筆,勤能補拙。本來還想安利一下我微博喜歡閱讀的幾個科技號,但有沾人家地氣的嫌疑,看我經常轉發的微博就知道是哪些了。如果讓你有了第二天自己寫一篇安利文的沖動,也算這篇文章沒有白寫。下一篇是自己練習寫的安利文例子,希望大家喜歡。

歡迎隨手微博@慧積木合,或者關注微信公眾號『懶文』(有認證那個),或者加App獨立開發群? 『533838427』(找不到風投只好借個地方介紹下自己的社交賬號,我準備倒騰個不僅能扯蛋,還能把扯的蛋做成APP,還能把APP可能不會丟臉的代碼拿來開源的科技類公眾號。嗯嗯,我是個半吊子恰好稍微ios、android、php、.net、公眾號、前端、設計都會點的Uber司機)。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容