如何撰写伟大的网页开发文章和教程

网站建设 2015 11月27日 发布

正如您可能已经知道,自2014一月以来我一直致力于为SitePoint作为他们的一个责任编辑,主要是编辑HTML,CSS,和非内容。我也帮着移动内容,javascript,一些通用的网站的东西(Git的文章,构建工具,和其他通用的内容),我写的主要通讯SitePoint的每星期。

我爱我的工作在SitePoint的这是我曾经最好的工作了。只要SitePoint仍然希望我为他们工作,我希望我能继续帮助他们把内容更好的前端开发人员。

自从我开始编辑工作以来,我已经拒绝或发送一些编辑文章了。许多人拒绝遭受同样的问题。所以对于这篇文章,我把我的想法放在我认为对一个好的网页开发文章或教程。

一些开场白

在进入这之前,让我们从中得到一些东西:

不是每个人都会同意我的观点。

我不写这篇文章,因为我觉得我比别人好。我们都有自己的优势。我不完美。我可以说出100个比我好的开发者/作家。

许多在这个岗位的项目是从一个文件我已经有一段时间了,我已经通过了编译,对作家SitePoint,帮助他们提高。

这些技巧中的许多适用于任何类型的写作,不仅是技术或发展。

我的观点在这篇文章中不一定代表那些SitePoint或其管理。在SitePoint的编辑有很多自由塑造的内容,但它仍然受制于SitePoint的指引,这可能与我自己在这里说。

有了,有点拖了出来(更晚了!),让我们到主要观点。

添加支持语句的链接

文章几乎总是有参考链接。如果你写的是前端技术,你的内容应该慷慨地连接到类似的东西:

W3C规范

MDN的参考

权威文章受到尊敬的社会成员

好的文章由同一出版商,你写的(最好是不老的)。

如果你对一个特定的工具或技术(如特定的jQuery插件或CSS预处理器),你的第一段应该链接到首页,技术。如果你是在谈论一个新的工具或技术或者一个不是众所周知的。在某些情况下,如果工具是常见的上下文(如在博客上关于SASS Sass),那么你可能是罚款不包括一个链接到SASS的主页。

你还应该包括链接,以支持某些类型的报表。例如:

“谷歌认为搜索引擎优化排名的页面速度。”

“研究显示,人们扫描网站,他们不读他们。”

“flexbox支持IE11。”

“汉堡包的图标是不好的可用性。”

以上所有的报表(和类似的)应该来自。特别是如果你谈论的是一个有争议的话题,人们会讨论你。然而,有些语句是意见。如果是这样的情况(例如第四点以上),那么你应该清楚地说明,这是你的观点,并给出理由。

作为一个例子,这篇文章对可访问性提到了一些案例研究。注意这些研究并不仅仅是讨论,它们是来源于链接。

链接到文档

要链接到源点相关的,如果你正在谈论的特定功能的引导,或蔬菜,或其他工具或框架,你应该联系的部分在他们的文档,你需要讨论。例如,如果你正在谈论的Bootstrap的超大屏幕组件,连接到它。

有时候我觉得作者害怕链接到一个工具的文档,因为他们觉得他们会暴露他们的研究的秘密”。也许我错了,但这似乎是这样的。

链接到特定的文档部分,帮助读者有一些额外的东西来寻找应该出现的需求。它表明你尊重这个工具的官方文档的权限,并获得读者的尊重。

连接到最新版本的规格

我犯了这个错误,我几次。如果你说的是,例如,你可以搜索flexbox,规格和找到一个链接是这样的:

http://www.w3.org/tr/2014/wd-css-flexbox-1-20140325/

但这是一个静态版本的规格,不会改变。你想要的是对规范的当前版本的永久链接,确保URL看起来更像这:

http://dev.w3.org/csswg/css-flexbox/

有时,不幸的是,一个谷歌搜索会带来一个“快照”的版本。你可以通过网址来告诉你。

如没特殊注明,文章均为善微网络原创,转载请注明来自https://www.sanways.com/news/113.html