正如您可能已經(jīng)知道,自2014一月以來我一直致力于為SitePoint作為他們的一個責(zé)任編輯,主要是編輯HTML,CSS,和非內(nèi)容。我也幫著移動內(nèi)容,javascript,一些通用的網(wǎng)站的東西(Git的文章,構(gòu)建工具,和其他通用的內(nèi)容),我寫的主要通訊SitePoint的每星期。
我愛我的工作在SitePoint的這是我曾經(jīng)最好的工作了。只要SitePoint仍然希望我為他們工作,我希望我能繼續(xù)幫助他們把內(nèi)容更好的前端開發(fā)人員。
自從我開始編輯工作以來,我已經(jīng)拒絕或發(fā)送一些編輯文章了。許多人拒絕遭受同樣的問題。所以對于這篇文章,我把我的想法放在我認(rèn)為對一個好的網(wǎng)頁開發(fā)文章或教程。
一些開場白
在進(jìn)入這之前,讓我們從中得到一些東西:
不是每個人都會同意我的觀點。
我不寫這篇文章,因為我覺得我比別人好。我們都有自己的優(yōu)勢。我不完美。我可以說出100個比我好的開發(fā)者/作家。
許多在這個崗位的項目是從一個文件我已經(jīng)有一段時間了,我已經(jīng)通過了編譯,對作家SitePoint,幫助他們提高。
這些技巧中的許多適用于任何類型的寫作,不僅是技術(shù)或發(fā)展。
我的觀點在這篇文章中不一定代表那些SitePoint或其管理。在SitePoint的編輯有很多自由塑造的內(nèi)容,但它仍然受制于SitePoint的指引,這可能與我自己在這里說。
有了,有點拖了出來(更晚了!),讓我們到主要觀點。
添加支持語句的鏈接
文章幾乎總是有參考鏈接。如果你寫的是前端技術(shù),你的內(nèi)容應(yīng)該慷慨地連接到類似的東西:
W3C規(guī)范
MDN的參考
權(quán)威文章受到尊敬的社會成員
好的文章由同一出版商,你寫的(最好是不老的)。
如果你對一個特定的工具或技術(shù)(如特定的jQuery插件或CSS預(yù)處理器),你的第一段應(yīng)該鏈接到首頁,技術(shù)。如果你是在談?wù)撘粋€新的工具或技術(shù)或者一個不是眾所周知的。在某些情況下,如果工具是常見的上下文(如在博客上關(guān)于SASS Sass),那么你可能是罰款不包括一個鏈接到SASS的主頁。
你還應(yīng)該包括鏈接,以支持某些類型的報表。例如:
“谷歌認(rèn)為搜索引擎優(yōu)化排名的頁面速度。”
“研究顯示,人們掃描網(wǎng)站,他們不讀他們。”
“flexbox支持IE11。”
“漢堡包的圖標(biāo)是不好的可用性。”
以上所有的報表(和類似的)應(yīng)該來自。特別是如果你談?wù)摰氖且粋€有爭議的話題,人們會討論你。然而,有些語句是意見。如果是這樣的情況(例如第四點以上),那么你應(yīng)該清楚地說明,這是你的觀點,并給出理由。
作為一個例子,這篇文章對可訪問性提到了一些案例研究。注意這些研究并不僅僅是討論,它們是來源于鏈接。
鏈接到文檔
要鏈接到源點相關(guān)的,如果你正在談?wù)摰奶囟üδ艿囊龑?dǎo),或蔬菜,或其他工具或框架,你應(yīng)該聯(lián)系的部分在他們的文檔,你需要討論。例如,如果你正在談?wù)摰腂ootstrap的超大屏幕組件,連接到它。
有時候我覺得作者害怕鏈接到一個工具的文檔,因為他們覺得他們會暴露他們的研究的秘密”。也許我錯了,但這似乎是這樣的。
鏈接到特定的文檔部分,幫助讀者有一些額外的東西來尋找應(yīng)該出現(xiàn)的需求。它表明你尊重這個工具的官方文檔的權(quán)限,并獲得讀者的尊重。
連接到最新版本的規(guī)格
我犯了這個錯誤,我?guī)状巍H绻阏f的是,例如,你可以搜索flexbox,規(guī)格和找到一個鏈接是這樣的:
http://www.w3.org/tr/2014/wd-css-flexbox-1-20140325/
但這是一個靜態(tài)版本的規(guī)格,不會改變。你想要的是對規(guī)范的當(dāng)前版本的永久鏈接,確保URL看起來更像這:
http://dev.w3.org/csswg/css-flexbox/
有時,不幸的是,一個谷歌搜索會帶來一個“快照”的版本。你可以通過網(wǎng)址來告訴你。