Как вы пишете технические блоги? [закрыто]

Я обычно много читаю о программировании. Когда тема, которую я читаю, не связана напрямую с моей работой (скажем, читая о некоторых алгоритмах, которые я не использую в повседневной работе), я забываю их.

Один из способов закрепить то, что было изучено, - это писать блоги. Я новичок в написании блогов. Когда я начал писать, я понял, что это очень сложно. Даже простое воспроизведение контента занимает около двух часов. Написание хорошей мысли о блоге часто занимает целый день или иногда выходные.

Это нормально? Любые советы, чтобы написать технические учебники / технические блоги?

Писать сложно, хорошо писать еще сложнее. Смысл в попытках объяснить что-то состоит в том, что для этого требуется больше знаний, чем просто «знать это». Я обнаружил, что, ведя блог, я 1. выясняю соответствующие темы, которые мне нужно понять, 2. определяю, где мое понимание поверхностно

Прочитайте эти слайды http://www.ai.uga.edu/mc/WriteThinkLearn.pdf . Они многое объясняют о написании (и даже сравнивают это с программированием)

Каждая качественная работа требует времени и усилий. Этого следовало ожидать.

Некоторые из моих старых записей в блоге заняли около 3 недель. Вы пишете черновик, перечитываете его, вносите необходимые исправления, снова сканируете его, затем корректируете его. Это требует времени.

Одна простая идея, как сохранить мотивацию. Если вы планируете что-то большое, подумайте, есть ли смысл разделить работу на 2-3 части и опубликовать их отдельно. Части, конечно, должны быть полезны для ваших читателей сами по себе. Тогда, поскольку они занимают меньше времени, вы, скорее всего, справитесь с этим и доведите часть работы до конца.

Несколько советов от этого неизвестного технического блоггера:

• Проверьте (не просто прочитайте) код, который вы ввели, вырезав и вставив из предварительного просмотра в командную строку или текстовый файл для запуска. Некоторые вещи (например, окончания строк, отступы и символы Юникода) могут быть испорчены при переносе из редактора (или оболочки) на веб-страницу и обратно.
• Получить человек для проверки правописания, грамматики и содержания - это показывает , что некоторые усилия пошли в создании статьи исправить и легко читать. Если вокруг никого нет, обязательно перечитайте всю статью перед публикацией.
• Если у платформы блогов есть подсветка синтаксиса , используйте ее. Если нет, опубликуйте код где-нибудь, где он есть и ссылку там
  • Следствие: держите огромные куски кода подальше от текста статьи. Это немного расплывчато, но если в тексте объясняется, как работает какой-то код, можно добавить фрагмент кода. Если он представляет часть программного обеспечения для загрузки, лучше обратиться к веб-интерфейсу VCS.
• Каждая статья должна быть читабельна сама по себе . Ссылки на другие статьи - это хорошо, но не думайте, что читатель читал какие-либо посты до этого.
• Используйте другие форматы, кроме текста, когда они помогают пониманию. Для некоторых вещей достаточно кода, но для некоторых изображение или даже анимация могут быть гораздо более понятными.

Часто я нахожу, что трудная запись в блоге занимает так много времени, потому что требует исследования; это исследование не только поможет вашему посту в блоге, но и поможет вам в процессе накопить свои личные знания. Как вы сказали, вы укрепляете знания, написав пост; Вы также расширяете свои знания. Примите время, которое требуется, и оцените его как опыт обучения.

Да, это нормально для написания технических блогов, которые занимают время. Для меня написание занимает самое короткое время (всего час, или до дня, в зависимости от продолжительности). Тогда редактирование и перезапись обычно занимают больше времени (до двух или даже трех дней). Другой упомянутый аспект, требующий времени, - прояснение любого примера кода. Кроме того, мне нравится тратить время на поиск вспомогательных ссылок для моих тем. Все это требует времени!

Я думаю, вы могли бы сейчас писать технические блоги, но я бы посоветовал вам сделать это, когда вы станете экспертом в какой-то конкретной области. Проводить выходные не кажется слишком много времени. все зависит от сложности темы. Я предполагаю, что я говорю о том, что суть вашей идеи должна прийти к вам естественным образом. Исполнение может (и будет) занимать больше времени.

Люди ищут советы экспертов в блоге ... а не эксперименты нубов. но я говорю в общем смысле .. я не хочу отговаривать вас писать блоги. Но имейте в виду следующие вещи.

1. Ваш блог должен сказать что-то новое. Не просто собирать данные и поставить его на свой собственный блог

2. Будьте абсолютно уверены в том, что вы говорите , то есть придерживаться сильных эмпирических результатов или тщательно протестированные понятия или вещи , которые вы пережили первую руку .

3. Будьте готовы к критике.

4. Изучите приемы написания блогов (точность, лаконичность и т. Д.)

5. Напишите что-нибудь, потому что вы думаете, что это должно быть написано; не потому что вы думаете, что это будет прочитано.

Элементы стиля

Я думаю, что техническое письмо следует тем же правилам, что и любое письмо. Если вы читаете только одну книгу о написании, это должны быть классические Strunks «Элементы стиля» . Он проходит список вещей, которые улучшат вашу композицию, в первую очередь (IMO), «Пропустить ненужные слова».

Я бы также порекомендовал Стивена Кинга " Написание ". Будучи больше о вымышленном письме, он все еще содержит много драгоценных камней для любого начинающего писателя, особенно в таких областях, как редактирование и процесс письма.

Это говорит о том, что трудность технического письма заключается не в самом написании, а в прояснении ваших мыслей о том, о чем вы пишете. Неразумное мышление ведет к плохому письму. Хорошее письмо требует от вас четкого понимания вашей темы, поэтому преподавание и письмо - отличный способ освоить предмет.

Ну, у меня уходит очень много времени на написание постов в блоге, да. Я часто пишу их в течение нескольких дней или даже оставляю их в виде черновика на пару недель, иногда перечитываю их снова и исправляю и немного подправляю тут и там.

На это нужно время, но если это цена за то, что я написал потом, мне не стыдно, я думаю, это того стоит.