如何为IT杂志和博客撰写文章



最近,Xakep.ru的主编Andrey Pismenny在我们的YouTube频道发表了讲话。



关于技术,科学和商业的数百篇文章的书面作者。作为编辑,他帮助作家找到了自己的风格,将思想转变为连贯的故事。



在本次演讲中,他将与您分享在处理有关技术的文字时会派上用场的经验和技术。



我们分享广播录音和成绩单。



我叫Andrey Pismenny,我是XAKEP杂志的主编。我认为不需要告诉任何人XAKEP是什么。我已经在该行业工作了14年,我可能已经在所有大型的IT主题出版社-TechnoMir(aka IgroMir),Computerra中工作了。



我仅在2015年加入XAKEP杂志,所以我只知道最近五年的历史。人们可能会想听听的那些传说(在有关哈布雷的评论中被问及了这些传说)对我来说也是传说。今天,我主要谈论我最了解的东西:技巧,这些技巧可以帮助我撰写技术文章并使它们变得更好。我也很高兴谈论XAKEP中的工作,但是它会回答问题。



我专门从Compulent开始工作,Compulent是Computerra杂志的附属新闻网站:在头六个月里,我写了一些小新闻,每条500个字符。对我来说,这是最好的经历。我并不是说这是每个人都应该从这里开始的方法,但是阅读英语文章和新闻以及将其重复压缩十次(通常约为5000个字符)的经验有助于学习如何从零开始编写更好的东西,从而减少所有不必要的事情。好吧,我当然也改进了英语-今天,对于每个需要使用源代码的人来说都是必要的。这与使用Google翻译不一样。我在Komuterre总共工作了大约10年,在很短的时间里,我去了TechnoMir撰写Mobi杂志。 2013年,我有自由撰稿人的经验,不到一年就为各种出版物撰写文章。其中包括XAKEP!我们以某种方式立即发现了彼此,我开始定期在那儿写东西。 2015年,我在Ferra.ru工作,并受邀加入XAKEP担任编辑。两年前,我成为主编。



当然,我很早就了解XAKEP。在2000年,我第一次看到了这个问题,买了下来,读了下来,使自己摆脱了原来可以写在纸上的尴尬事情。在那些日子里,令人震惊,结束了。现在观众已经成熟,现实也发生了变化。总的来说,在我进入该杂志的那一刻(2015年),它正经历一个重大的转折点。在完全在线翻译之前,我看到了最后三个论文的发行版。不幸的是,关闭纸质版的决定并不取决于编辑,但我们在线上感觉很好。这种模式离我很近:我喜欢我们为订阅者发布文章,并直接向人们收费以提供阅读该杂志的机会。我非常感谢我们的订阅者使之成为可能。我们不依赖广告,没有人规定要做什么,除了我们的读者以外-很酷,我真的很高兴它能奏效。这使我们可以向作者付款,并谨慎处理文章编辑问题。



我会告诉你一个秘密:黑客们写得可怕!作为XAKEP杂志的编辑,对我来说是一个巨大的挑战,我以前从未见过这样的文章。我不是在冒犯任何人。事实是,黑客是不会构建的技术人员,而是凭借其直觉来了解复杂系统的工作原理。与工程师不同,他经常头脑混乱,这有助于他找到直观的解决方案。好吧,他相应地写了-我们帮助将所有这些都拉到一个人可以进入并阅读文本的水平,这不会太困难。



让我们继续到主要部分。首先,让我们谈谈即使您是技术人员,为什么也需要能够撰写文章。当我在人道主义学校上学时,我震惊地看到了相反的例子:信息学课上的学生做出了这样的反应:“是的,我根本不需要它,不需要计算机,我会做真实的事情”。我怀疑那些主要在俄语和文学课上学习技术学科的人也会发生同样的事情。他们很无聊,在他们看来很难得到一些有趣的东西,他们将不再需要处理这个问题。但是,实际上,当工程师做一些有用的事情时-当他长大,上班,晋升并开始做值得谈论的事情时-他应该能够转移自己的知识。他必须能够描述自己在做什么,在专业社区中推广您在工作中的想法。此外,撰写文章时,您总是会更好地了解问题。这是写文章的另一个原因,除了经验和知识的转移外:您可以弄清楚自己尚未完全理解的内容。根据我的经验,在您坐下来撰写文章之前以及撰写文章之后,了解主题的细微差别和细节是天堂。



当我们在上学校课程时,我们当然会被教导写作,但并不是我们应该采用的方式。例如,美国学生不断写论文(您可能已经在文学或电视节目中看到过这种论文),而这些论文不等于关于文学的论文。他们可以处于不同的主题,在他们的帮助下,人们学会撰写关于不同事物的文章。我们没有这种做法,在文学中,他们只是教他们在重复本课内容的同时正确写出所有单词。不幸的是,这里的书写能力存在问题。进行合理辩论的能力也会出现问题-尽管应该这样做,但我们不教它。



撰写文章的第一步是查找主题。有时它是事先已知的:也就是说,您坐下来描述(或被要求描述)您所知道的东西。但这并非总是如此。新作者对此常常感到困惑。一个人可以做很酷的事情,但是要了解哪个主题在这个大事情中很有趣总是很重要的。我建议您考虑在谈论工作时可以谈论哪些有趣的事情。也许还记得我最近告诉某人的故事。我真正想谈论的是您目前真正想做什么的事情-这很可能值得一写:然后很快就会好起来。



新作者的一个常见错误是提出一个过于笼统的话题。无需尝试将一篇可能写成三卷的书写进一篇文章中,而是需要选择特定的主题,设置一个框架。实际上,前几篇文章很难写成文章,但是随后您就会从正确的框架中看到所有内容。认为:“我知道别人不知道的什么?”就足够了。



我还建议与假冒综合症作斗争。这是众所周知的事情。一个人认为:我是谁,我写了一篇如此严肃的话题,认真的人在上面做科学工作。但是,以杂志的形式,当一个人在一段时间前遇到了这个话题并且已经设法自己弄清楚了一些东西,却又没有时间忘记新人提出的问题时,发生的事情就非常酷。此刻,该人已经有足够的知识坐下来进行修复。



我不建议将话题归结为某种东西的存在。最好选择一些主题来揭示目标的实现方式,或者为什么一件事情要比另一件事情更好(例如,选择某个程序而不是另一个),然后以叙述或比较的方式告诉它。至少那是我的经验。

当然,碰巧主题的发展已经到了死胡同,出于某些客观原因,不可能发展它。您可以随时向编辑咨询或告诉您认识的人-也许此刻将诞生针对该主题的另一种方法,这可以节省时间并以不同的方式讲述它。通常,您只能在某个地方查看(查看)格式。新作者可能很难想出文章的格式和叙述的顺序-但是监视他们并不可耻。您可以以同样的方式谈论另一件事。



我建议开始写带有标题的文章。如果您能拿出一个好的标题,那么一切都会好起来的。您不必专注于显得特别英俊或机智-足以使其易于理解。机智可能会在写作时稍后出现,或者您可能不会考虑。一个好的工作标题概述了进一步工作的范围,这很重要:与作者一起,我们通常讨论本文将拥有的工作标题。我还请您为该文章写一个简短的“广告”:它将是关于什么,它将包含什么。这是您可以期待的文章的最佳开始。



我建议您在标题中使用动词。如果是这样,则表示该文章描述了一个操作。如果将该文章称为“ TCP / IP协议”,则很可能是一篇很无聊的文章,仅描述了一些现有内容。在这样的文章中,作者将审视此事,而不会发生任何事情。但是,如果这篇文章被称为“如何为某种目的使用TCP / IP”,那么它的概述会更好,并有望变得更加有趣,因为在其中我们做某事,而未描述任何事。

通常,当您坐下来考虑要写些什么时,人们会面临空白的问题。对于这种情况,民间艺术提供了非常有效的建议(将孩子从屏幕上移开):以“所以,该死,总之!”开头。然后,文本开始独立进行。然后,当然可以删除“简介”。这么开玩笑,但实际上是真的:如果您以非正式的方式开始,那么谈论任何话题都将变得更加容易。



我经常使用“在草稿中写东西”技术,通常为此使用三角括号(在我的编辑器中,该文本以灰色突出显示)。您可以使用任何技术:例如,用斜体写或在另一个编辑器窗口中写。当您无法说出漂亮的话-或认为自己做不到时,编写“临时”文本有助于克服障碍。然后,您可以查看文本并理解:您可以在这里和那里进行更正,这会很好。有时您不必统治。



您不应该写冗长的介绍。如果一篇文章以典型的“技术在我们的生活中变得越来越密集”开头,那么编辑者将把它排除在文本之外。我什至举一个最近的例子:“近年来,人们越来越多地使用手机作为与他人交流的手段。”您不会告诉任何人带有此类段落的新内容。如果有帮助的话,您可以先编写然后擦除(否则编辑器将擦除),但是您无需坐下来专门以这种“平凡的”角度来发明这种方法。只是从行为开始,而不是序言或引言。完成本文后,您可以返回并添加文章的简洁内容作为第一段-读者可以从中理解为什么他需要阅读本文。在编辑过程中,我会这样做:阅读文章,然后我回到开头并写下“ lead”-第一段。有时,它是通过杂志以某种特殊方式设计的。最好的线索传达了一个人为什么应该阅读这篇文章-这使浏览变得容易。我已经说过,在XAKEP,我们通常要求您写一篇简短的文章描述,一个段落。通常,它可以很好地带头,并允许您在社交网络中刊登广告。



自然,最大的问题是如何写作。最好在这里向已经尝试过,有实践经验的人进行解释,但是可以给出一些建议。一个新人坐下来并想写点东西的主要问题是试图听起来更有权威性。每个没有经验的作者都试图模仿他认为具有权威性的样式,例如“警察规约”或“科学文章”的样式。由于渴望听起来很沉重,有时会出现疯狂的珍珠。例如,“一种提高使用恶意站点对匿名Web用户进行匿名处理的效率的方法”来自真实文本。在我看来,根本听不见它。以文本的形式-我原则上理解作者希望以此字符串形式传达八个名词,一个在另一个之上。通常,您必须绝对考虑人们将如何阅读文本,而不是尝试听起来比合理的发音更聪明。在这种情况下,例如,可以简单地写“如何避免deanon”。



人们还喜欢复制“古老而优美的文字”风格,并扔掉“直到”,“如果”,“用于”等词语,以使文本更加美观。实际上,它并没有变得更加美丽。混杂着技术术语和科学风格的尝试,看起来真是地狱,您必须将所有东西扔掉。最好直接用简洁,干净的俄语书写。我建议在尝试建立“独特的写作风格”之前,学习用新闻中常用的无菌语言写作。最好先学会使用简短明了的句子,而不要尝试模仿科学文本-之后,您已经可以考虑独特作者的方法了。



一个简单的规则:您需要编写所有需要的内容,然后丢弃所有不需要的内容。当然,在实践中,这比较困难。一般而言,应遵循两个重要原则:使其更短并且更诚实。也就是说,有必要丢弃所有无助于传达含义的不必要的单词,而且-我们必须尝试传达含义,而不是以某种方式作弊。如果突然发现您要隐藏文本中不存在的某些事实,首先,这很困难(有时比找到答案要困难得多),其次,没有必要。您需要与读者进行诚实的沟通。与其写“最近有很多大公司的人……”,不如简单地找到确切的时间,确切的人以及在哪个公司。也就是说,您需要处理造成不准确的时刻。这将使文本更好,更丰富,更易理解。如果在写作时脑海中有一个问题在旋转,则需要抓住它,将其拔出并回答。你必须对自己诚实。如果您尝试这样做,那么如果以问题的形式表达出不够清晰的话,那么是否可以回答就会变得很清楚。而且,如果可以回答,那么文章应该有答案。如果无法回答,则需要直接写信:“这里可能会出现问题,但是很遗憾,我没有答案”。然后,读者将有这个问题。首先,也许他本人会知道答案。其次,他不会试图在模糊的文本中寻找答案,也不会怀疑自己,并会在作者本人不知道答案时认为“我错过了这个重要问题的答案,没有这个答案是不可能的”。当然,您将无法始终做到这一点,但是如果您尝试这样做,那么这些文本将变得更加简单明了。



好吧,当然,您需要删除所有没有直接含义的单词:“足够”,“相对”,“足够”。被发现时,必须将它们丢弃。如果没有这样一个词,却发现它是``不真实的''(例如,它是``相当紧急的'',但是却变成了``紧急的'',尽管实际上它并不很紧急),那么整个短语最初的含义是失真的,您需要用一个更合适的词来代替。当文字中没有近似于其他单词含义的单词时,文本会感觉更强大。顺便说一句,“顺便说一句”通常是不合适的,在这个词之后,人们通常报告完全无关紧要的事情。



还有一件事-我称这种情况为“广播”。在口头演讲或广播中,通常会宣布某些事情即将发生。这是正常现象,但是全文已经摆在文章读者面前。他本人可以完美地预见接下来会发生什么以及之前发生了什么-无需宣布任何内容。作者仍然非常喜欢“如上所述”,“提醒”,“解释”一词-在他们之后,他们重复已经说过的话,或者确认已经说过的话。人们根本不需要这些提醒。如果您确实需要再次提及一个事实,那么您可以不讨论而再次提及它,或者在新的上下文中以其他方式提及它。我经常扔掉“提醒”和“解释”一词-代替它们,您可以简单地提醒和解释。在英语教科书中,此规则称为“显示,不告诉”-“不告诉,而是显示”。无需宣布您将要做某事,只需要这样做。每个人都会明白。



关于广播:人们经常将文章和广播节目混淆。由于某种原因,它卡在XAKEP中,而且我经常看到以“ Hello!”开头的文本。并以“再见”,“敬请期待”等结尾。也许这是某种作者的把戏,对某人来说很酷,但对我来说很奇怪。有点像一个人试图用文字描绘DJ。我们通常会删除此类内容。



通常会发现太复杂的文本。也许是托尔斯泰(Leo Tolstoy)对学校里的人们的伤害,他们正试图无休止地延长刑期。一个人应该努力按照一种简单的方案工作:主体谓词客体,不需要其他任何东西。如果结果很长,那么最好将其分解为几句话。您几乎总是可以删除括号。如果有括号,则可以毫无问题地分成两个句子。



有很多被动的声音-这是当主体没有执行动作而是要执行动作时。您还需要摆脱这一点。最好到处都有有效的声音-“有人在做某事”。以同样的方式,您可以删除gerunds,分割长句子,摆脱相反的单词顺序。所有这些都会损害对文本的理解,最好删除它们。编辑者首先要摆脱它们。



最好写一个段落,重新阅读它,然后想想说同样的话是否容易。当然,这是艰苦的工作,但是通常人们甚至没有意识到它就做。有时,一个人写了些东西,然后用不同的词写了同一件事,但用一种更简单的方式来描述。在这种情况下,您可以删除“其他字词”之前的所有内容,仅保留一个简单的解释。也许将第一个到第二个重新排列为指定因素。当然,有两种方法可行,但这项工作将帮助读者精读复杂的技术文章。



还有很多问题,例如重言式,但这是可以理解的:这是在学校教的。

未经编辑的文本中常见的错误是“公司采取行动”。这是一件更微妙的事情,原则上,您第一次可以忽略它并写下它的运行方式。编辑器会做。最重要的是,公司就是人。只有人才能行动,而不是公司。有时将公司称为复数形式。 “微软决定了,”“ Facebook做了。”相反,您可以指定是编写“ Microsoft工程师”还是“ Facebook管理”,这听起来会更聪明。



完成有关样式的讨论:一般的建议是让自己思考“很好”。头是不可靠的事情。此处与编辑代码时相同:linter错误消失了,但并没有在我的脑海中徘徊,因为您认为“好吧,无论如何这都会起作用,每个人都会明白我的意思”。与俄语和风格有关的最可怕的错误正是在这样的时刻发生的。如果您陷入困境,请再考虑一下您允许自己做出的那些决定,那么您将发现不一致之处和结构错误的句子-所有样式错误。



当然,只要您愿意,就可以继续使用样式提示-上面有整本书。我认为有抱负的作者至少需要知道这一点。当然,开始写或写一点不全,主要是完成文章。如果文章没有完成,所有的工作都会浪费掉。很多时候,作者失踪,拿出惊人的借口,告诉他们一切都枯竭了,等等。实际上,这通常意味着该人要么无法专心致志地完成任务,要么无法清楚地想象任务本身。了解您是否了解要写的内容非常重要。一旦您开始问自己一些主要问题,就会出现各种各样的问题:“我不知道”,“我想先了解这一点”,“我想提出或讨论”。这是非常重要的。通常,您无法动弹,因为您不知道确切不知道什么。这也许是最大的问题。强迫自己工作是一个小得多的问题,我自己真的很想被所有事情分散注意力。



信使,Twitter,YouTube订阅,有人一直在写信-特别是在您远程工作时。我强烈推荐番茄计时器(“番茄法”)-这是常见的厨房计时器。您可以在Internet上使用数百万个计时器程序之一。许多谈论生产力的人都推荐一个简单的算法:15-25分钟的辛苦工作,5-10分钟的休息时间。可根据个人喜好和任务进行定制。例如,写作非常困难,我通常只给自己15分钟,然后休息5分钟。在这15分钟之前,最主要的是不要分心。电报中很少有消息不会等待15分钟。



另一个技巧:写东西时,常常会想到您在本文中还能写些什么。这些想法非常有价值。它们表示磁头正在满负荷工作,并且不能被扫掉以完成写入。我们需要找到一种平衡:完成写作到一定程度,以免忘记您写的内容,然后去发展或至少保持思想。我通常会在课文的结尾流行一句,在其中我输入已经出现的想法,以便自己了解其含义。有些想法是您需要查看某些内容,或纠正文本中的某些内容,或提及某些内容。所有这些都必须保存,然后在空闲时进行处理。不可能连续书写:头部开始烘烤,开始停止,不知道接下来要写什么。也许是因为思维过程的一部分是潜意识的形成,他也应该有时间工作。发生这种情况时,您可以修复格式或只是在文本末尾重新阅读笔记。



如果我厌倦了写作,但计时器仍在滴答作响,那么我通常会重读上一段或本章开头的内容。如果您不远,则可以从文本开头重新阅读。这有助于纠正,重新编写所写内容。当我回到我离开的地方时,障碍有时会自行溶解。



通常,始终寻找昏迷的原因非常重要。如果您突然停在某处而又不知道如何进行,则可以重新阅读,反思,了解所缺少的内容。

我的生产力一直很艰难。我不断地分心,我想做错事,我喜欢完全的副业。自然地,您必须-尤其是在进行诸如刻录编辑室之类的工作时,要发明一堆有助于解决问题的生活技巧,以使任务不会丢失,并且通常不会消失。我认为许多对生产力感兴趣的人已经阅读了《完成事情》,但不幸的是,它没有考虑电子工作流程和电子通信。知道它是如何工作的很有用,但是可以在生活中受到限制和调整。



我爱的另一件事是收件箱干净。这是非常有用的。我知道人们有一个废弃的垃圾堆,邮件中有700条未读消息,但是收件箱不仅是电子邮件。这些情况可能会在不同的地方累积。我尝试耙平所有内容,确保邮件客户端和其他位置均未阻塞。您只需要快速决定是否要做某事。如果您需要紧急回答某人,那么您可以用两个单词来做大老板的作法-通常,从您那里得到两个单词总比什么都没有要好。这对于编写很重要:要有一个清晰的头脑,而不要列出任何悬而未决的任务,这总是更好。通过完成工作,所有这些事情都需要写出,并在有时间,机会或上下文的情况下退还给他们。



作为远程通勤者和前自由职业者,我建议您有几个小时的休息时间和工作时间。这很重要。有些人甚至在工作时间打扮自己,就像要去上班一样,总是坐在桌子旁(有时甚至在办公室里),但这已经超出了梦想的境界。但是您至少应该能够工作一段时间,并尝试在设定的时间之前完成任务。并且能够放弃所有这些任务而去处理您的个人事务,而不是放弃它们。



您还可以做些什么来提高自己的写作技巧?你必须阅读。此外,不仅要阅读诸如Habr之类的社交媒体,其中的文本质量会有所不同,而且还要阅读专业文本-一些Kommersant,Vedomosti,Esquire。尽管Esquire更像是一种文学材料,但没有必要在技术文献中将其等同。当然,仅阅读并不能帮助您学习写作-您仍然需要为此写东西。至少以某种方式。别害羞:下次会更好。没有实践就没有办法。作为编辑,如果可能的话,我当然建议与编辑一起工作。我本人对主要编辑和文学编辑都很感激:让他们发誓,大笑,有时甚至冒犯别人-默默地统治。您应该始终看看为什么修复了某些问题。如果您了解此问题的原因,那么很有可能您下次不会犯错。



当人们来到XAKEP并提供技术文章(尤其是与安全性相关的文章)时,我总是很高兴。我们准备帮助编辑,讨论主题。如果有人感兴趣,我们总是试图告诉您为什么文章中的某些内容要更正。



从您可以阅读的内容中,每个人都推荐Ilyakhov的“写,缩短”。好书。我没有读完整的书,但我看了看,所见所闻,我都同意。很高兴有人写这件事。还有Amzin撰写的“ Internet新闻”一书-这是Lenta.ru“技术”部分的前编辑。许多人喜欢Nora Gal的著作《活着的人与死者的话》,尽管我谨慎地对待它-那里的语言不太相关。您当然可以阅读有关方法。






之前发生了什么



  1. , Senior Software Engineer Facebook — ,
  2. , ML- — , Data Scientist
  3. , EO LastBackend — , 15 .
  4. , Vue.js core team member, GoogleDevExpret — GitLab, Vue Staff-engineer.
  5. , DeviceLock — .
  6. , RUVDS — . 1. 2.
  7. , - . — .
  8. , Senior Digital Analyst McKinsey Digital Labs — Google, .
  9. «» , Duke Nukem 3D, SiN, Blood — , .
  10. , - 12- — ,
  11. , GameAcademy — .
  12. , PHP- Badoo — Highload PHP Badoo.
  13. , CTO Delivery Club — 50 43 ,
  14. , Doom, Quake Wolfenstein 3D — , DOOM
  15. , Flipper Zero —
  16. , - Google — Google-
  17. .
  18. Data Science ? Unity
  19. c Revolut
  20. : ,
  21. IT-
  22. : ,
  23. ,









All Articles