您如何撰写技术博客？[关闭]

我通常会阅读很多有关编程的资料。当我阅读的主题与我的工作没有直接关系时（例如阅读一些我在日常工作中不使用的算法），我会忘记它们。

加强已学知识的一种方法是编写博客。我是写博客的初学者。当我开始写作时，我发现这很艰难。即使简单地复制内容也需要大约两个小时。写一篇关于博客的好书通常需要一整天，有时甚至是一个周末。

这正常吗？有编写技术教程/技术博客的提示吗？

写作很难，好的写作就更难了。试图解释某件事的事情是，它需要更多的知识，而不仅仅是“一定要知道”。我发现通过写博客，我1.找到我需要理解的相关主题，2.确定我的理解不够深入

阅读这些幻灯片http://www.ai.uga.edu/mc/WriteThinkLearn.pdf。他们解释了很多有关写作的知识（甚至将其与编程进行了比较）

每项质量工作都需要时间和精力。可以预料的。

我的一些较早的博客文章大约花了3个星期的时间才能完成。您编写草稿，重新阅读，进行必要的更正，再次扫描，然后校对。这需要时间。

一个简单的想法，如何保持自己的动力。如果您打算进行较大的规划，请考虑将工作分为2-3个部分并分别发布是有意义的。当然，这些部分对于您自己的读者当然很有用。然后，由于他们花费的时间更少，因此您更有可能顺利完成并完成部分工作。

来自这位未知的技术博客的一些技巧：

• 通过从预览剪切并粘贴到命令行或文本文件来验证（而不只是读取）输入的代码以运行。从编辑器（或外壳程序）传输到网页并返回时，有些事情（如行尾，缩进和Unicode字符）会弄乱。
• 找一个人来检查拼写，语法和内容 -这表明一些努力进入决策的文章纠正和易于阅读。如果周围没有人，请确保在发布前重新阅读整篇文章。
• 如果博客平台具有语法突出显示功能，请使用它。如果没有，请将代码发布在有该代码的位置并链接到那里。
  • 结论：使大量代码远离文章文本。这有点含糊，但是如果文本解释了某些代码的工作方式，则可以包含一个代码段。如果要提供要下载的软件，最好参考VCS Web界面。
• 每篇文章都应该自己阅读。引用其他文章也可以，但不要仅仅假设读者在阅读该文章之前已经阅读过其他文章。
• 当它们有助于理解时，请使用文本以外的其他格式。对于某些事情来说，代码就足够了，但是对于某些图像甚至动画来说，可能更容易理解。

我经常发现，一篇困难的博客文章花了很长时间，因为它需要研究。该研究不仅对您的博客文章有所帮助，而且还可以帮助您在此过程中建立自己的个人知识。如您所说，您通过撰写文章来增强知识；您也在扩展自己的知识。拥抱所需的时间，并将其视为学习经验。

是的，技术博客写作要花一些时间是正常的。对我来说，写作花费的时间最短（短短一个小时，最多一天，具体取决于长度）。然后，编辑和重写通常需要更长的时间（最多两天甚至三天）。提到的另一个需要花费时间的方面是澄清任何示例代码。另外，我喜欢花时间为我的主题找到支持链接。这都需要时间！

我想您现在可以写技术博客，但是当您成为某个特定领域的专家时，我建议您这样做。花一个周末似乎并不多。这一切都取决于主题的复杂性。我想我想说的是，您想法的核心自然会落到您身上。

人们正在博客中寻找专家建议。但是我说的是一般意义上的..我不想劝阻您写博客。但是请记住以下几点。

1.您的博客应该说些新的话。不要只是收集数据并将其放在您自己的博客中

2.绝对相信你说的话，即坚持以强有力的实证结果或严格测试的概念或东西，你有经验的第一手资料。

3.准备批评。

4.学习撰写博客的技巧（精确，简洁等）

5.写一些东西，因为你认为应该写东西；不是因为你认为它会被读取。

风格元素

我认为技术写作与任何写作都遵循许多相同的规则。如果您只读了一本关于写作的书，那应该是经典的Strunks “风格的元素”。它列出了将改善您的构成的一系列事项，最重要的是（IMO），“省略不必要的单词”。

我还建议斯蒂芬·金（Stephen King）的《写作》。尽管更多地是关于虚构作品的写作，但对于任何有抱负的作家而言，它仍然包含许多瑰宝，尤其是在编辑和写作过程等领域。

话虽这么说，技术写作的难点不是实际的写作，而是澄清您对所写内容的想法。思维混乱导致写作不良。好的写作要求您对主题有清晰的了解，这就是为什么教学和写作是掌握主题的绝佳方法。

好吧，我花了很多时间写博客文章，是的。我经常将它们写几天，或者甚至将它们以草稿形式放置几周，偶尔再读一遍，并在此处和此处进行一些修正和调整。

这需要时间，但是如果那是写后来我不感到羞耻的东西的代价，我认为这是值得的。