最近,在两篇文章之前,有一百篇文章发表在我们的公司中心。 为了纪念轮数,我们决定总结一下经验。 在本文中,我们将介绍开发人员如何处理文章,这将帮助他们编写文章以及在处理文本时应注意的事项。
首先,只需回答两个简单的问题:
- 我为什么需要这个?
- 我将对哈布拉社区说些有趣和有用的事情吗?
然后,您可以从本文中获取计划(或自己制定计划)并执行。
有创意和技术阶段。 本文是关于创意的。 考虑:
- 为什么写文章
- 在哪里获得本文的主题,
- 在哪里找到时间写它,
- 文字工作的主要阶段,
- 如果文章不刊登怎么办,
- 如果您从未用过Habr写作,从哪里开始。
我们希望该文本对其他Habr作者(包括潜在的作者)有用。
动机:作为开发人员,我为什么要用Habr写作
没有一个答案,也没有银弹。 因此,我们提供员工的答案,每个人都可以认出自己,我们将像您一样愉快地倾听。
- 社会化
善解人意和具有社区意识的动机-我想与感兴趣的社区分享对发展过程的情感和想法。 - 整理你的知识
我喜欢头脑中的顺序,写一篇文章或全文通常可以加快寻找关于该主题的理解和知识方面的差距。 本文使您可以从不同角度审视主题,以充分发现所有难以理解的时刻,以实现某些目标。 - 兴趣整理新分享
他激励自己写一些新东西,写一些发展中的新鲜事物。 如果我正在执行典型任务,那么我认为这不会有任何累赘。 总的来说,输出是带有或不带有笑话的指令,类似于在文章标题中对问题/主题进行Stack Overflow的详细解答。 - 节省内部培训时间
这篇文章是供以后仍然需要讲述的同事们编写的。 因此,他写了-并发送或举办了研讨会。 - 获得反馈和公司评论
在抵消中获得观点和优点是非常好的,它可以改善业障。 业力的提高也激励您进一步写作。 在评论中,您可以找到同样有用的人,这些人为自己提供了有用的信息。 - 为了最好
它的灵感来自于加速人类发展的愿望-如果作者的任何活动都会比人们节省更多的时间来节省时间-平均而言,人类可能会在发展中受益,因为节省的时间可能会花在有益的活动上。
考虑Habr实用性的学科选择
在选择主题时,我们将专注于我们的主观经验和实际案例,并进行了自我测试。 当然,假设我们已经提前学习了文学,并且不会重复已经写过的东西。 根据良好形式的规则,我们总是引用有用的资源。
好话题
- 开发人员会说一些解决方案:“在Habré上也没有任何官方文档。 我不得不修补。” 如果决定本身是体面的,那么该文章将是好的。
- 一些主题源于项目带来的全球挑战,例如,提供高可用性和透明的CI / CD。 朝此目标迈出的每一步-迁移到.Net Core,Docker等-可以在另一篇文章中进行描述。 在集会上,开个玩笑“成文章!”通常会跳过,即 同事好像在暗示。
- 当您积极研究新主题时,就会出现部分主题。 有迹象表明:如果开发人员花了4个小时以上的时间在Google上进行研究或阅读了其他文章,则值得至少汇编发现的信息,或者编写新的内容。
- 有些文字是在读了有趣的书,参加了一次很好的会议,甚至作为内部文档之后诞生的-我想分享新知识。
有益的是好的,可以为读者节省未来的时间,并提供实践经验,而不是对世界和平的哲学推测。
坏话题
其中有很多,但我们将提及其中一些:
- 重复所有已知的唯一目的是通过关键字建立索引,
- 公司或客户的直接或间接广告(请参见与我合作的人),
- 一篇关于无内容或无结构思想流的文章。
通常,所有不利于读者或不尊重他的事情都是不好的。
案文的主要工作阶段
对于作者而言,有关文本的工作经历了6个创作阶段:
- 目标设定:制定主题,想法和计划。 为了找到一个主题,我们回答了以下问题:“读者将从本文中学到什么新知识”,“我们为谁写作”,“我们到底想分享什么”。 对我们来说,文章带来新的内容也很重要。 为此,我们查看已经在该主题上编写的关键字,以及是否要重复自己。
- 注释或实验室日记。 在完成该任务的过程中,开发人员会做笔记:保存有用的链接,为紧急情况编写提醒锚,以便您可以将笔记反向工程为可读的文本。 涉及到文本时,仅需重新阅读“实验室日记”,使用或多或少被普遍接受的词汇来重新编写一些笔记,然后以逻辑顺序将它们组合起来。
我们的一位作者使用hackmd.io在线markdown编辑器,在那里他修正了开发该主题的步骤。 该工具使您可以共享文本,显示文章的进度,最重要的是-可以预先进行弥补。 结果,我们得到一个文本,可以在Habr上发布,足以添加剪切并给出几个小笔画。 这方便了控制文本的结构和布局。
- 安排文字。 我们写出主要思想,并考察它们的用处和在文章结构中的位置。 获得目录,即,将文本聚类为语义块,即使不阅读其他部分也可以感知。
- 我们进行编辑和编辑,以使“不在主题内的”局外人或多或少地理解所说内容的含义。 您每天至少可以重新阅读一次,然后编辑自己不喜欢的内容。 编辑需要多次迭代,文本工作也是如此。 在这个阶段,我们要研究语言和错误-未经验证的文本就像是由两个男生写的一样。
- 我们通过他人的眼光看待本文:另一位胜任此主题的开发人员或PM正在阅读本文。 新颖的外观和建设性的批评改善了产品。
- 我们正在准备印刷文本。 我们进行最终编辑,考虑插图,选择适当的中心-进行打印!
这些阶段的顺序并不严格。 碰巧的是,作者首先拟定了一个计划,将每个项目显示出来并详细描述到所需的水平,然后在多次迭代中更正了文本。 碰巧的是,开发人员首先概述了工作任务的解决方案,而在此基础上,Habr的文字就诞生了。 在任何阶段,其他同事都可以加入本文,以提出想法或建议。
现在从计划到行动。 也就是文字。
任务很多:如何找到时间来处理文字
由于
总线因素 ,对我们而言,以“拖下所有任务然后低着头”的方式处理文本对我们不起作用。 因此,作者在其余工作的背景下逐渐从事该文章。 文本通常是实际工作任务的纲要。
我们的一位作者将这项工作与测试进行了比较。 起初,您认为没有时间编写测试。 然后,您将此活动嵌入到该过程中-结果是有时间。 文本(例如测试)有助于理解正在发生的事情。 即使您每天分配给文章一次,它也可以解决。 当然,对于一个人来说是否重要。
另一位严格在早上写。 首先是第一件事。 知道他还有很多主要工作要做,因此从工作开始之初,他就可以花20分钟在文本上。 在这种情况下,事实证明要写得清楚,简洁。
我想写一篇关于Habr的文章,甚至想出一个话题。 从哪里开始?
这个问题没有什么新鲜的了。 Stephen King,George Orwell,Edgar Allan Poe,Strugatsky同志,Henry Lyon Oldie二重唱,Richard Feynman和其他许多作者以一种或另一种形式说:
“如果您想开始一些事情(写文章,书或给朋友的信),但是您仍然做不到–没有比现在更适合这样做的时间和情况了!”
我们中的一位帮助打开了文本编辑器,并在那里引发了一系列有关该主题的想法。 很有可能,这证明这是“全错”,但是已经采取了第一步-该文章的工作已经开始。
还有另一种方法:找到另一名员工,并告诉他文章的主题。 并以以下单词开头这个故事:“好吧,简而言之……”。 当第一个念头涌出时,大喊“谢谢!” 逃避自己,紧急写下你的故事。 简而言之,用生产垫子,然后用建设性的东西代替。
对于小吃,经典的方式完全由您负责。

我在写,我在写,我被卡住了。 怎么办
可以将三种情况应用于该情况:
- 喝杯茶放松一下。 当文字“不走”时,您当然不必强迫自己-克服这种困难没有任何好处。 顺便说一句,这不仅是写文章。
但是丢工作是不值得的。 一旦感觉到自己或多或少的放松,请重新阅读所写内容,以确保会想到其他想法。 绘制文本结构的轮廓。 将文字扔给同事。
在文本周围做一些事情,但不要勒索单词。 然后,思想本身将开始泛滥,只需要用尾巴抓住它们,然后将其照原样放在纸上/在文本编辑器中即可。 - 将所有材料“按原样”收集到文章的发布中。 在这一点上,您必须完成主要思想的写作或从逻辑上得出结论。 如果看起来不错,则其余内容可以转到下一篇文章。
- 深度且长时间的昏昏欲睡可能意味着该主题尚未结束,您无需撰写任何相关内容。 此类主题最好在第一阶段就切断。 或咨询同事。
如果您还有其他选择,如何摆脱创意僵局-在评论中分享。
总结
写。 不要听任何人写。 很好 而且您会写得很好-一般都很棒。 然后,habro社区将变得聪明,发誓并致富。
最后,指向该主题的有用链接:
在评论中分享您的食谱,等等!