Як ви пишете технічні блоги? [зачинено]

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

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

Це нормально? Якісь поради щодо написання технічних навчальних посібників / технічних блогів?

Писати важко, добре писати ще важче. Справа в тому, щоб щось пояснити - це те, що для цього потрібно більше знань, а просто "якось це знайте". Я вважаю, що, проводячи блоги, я 1. з’ясовую суміжні теми, які мені потрібно зрозуміти, 2. визначити, де моє розуміння неглибоке

Прочитайте ці слайди http://www.ai.uga.edu/mc/WriteThinkLearn.pdf . Вони багато пояснюють про написання (і навіть порівнюють це з програмуванням)

Кожна якість роботи вимагає часу та зусиль. Це варто очікувати.

Деяким із моїх старіших записів у блозі було потрібно близько 3 тижнів. Ви пишете чернетку, перечитуєте її, вносите необхідні виправлення, скануєте її знову, а потім перевіряйте. На це потрібен час.

Одна проста ідея, як тримати себе в мотивації. Якщо ви плануєте щось велике, подумайте, чи було б сенс розділити роботу на 2-3 частини та опублікувати їх окремо. Ці частини, звичайно, повинні бути корисними для ваших читачів самостійно. Тоді, оскільки вони забирають менше часу, ви більше шанси на те, що ви зможете це зробити і довести часткову роботу до кінця.

Деякі поради цього невідомого технічного блогера:

• Перевірте (не просто прочитаний) код, який ви ввели, вирізаючи та вставляючи з попереднього перегляду в командний рядок або текстовий файл, який потрібно запустити. Деякі речі (наприклад, закінчення рядків, відступи та символи Unicode) можуть зіпсуватися при перенесенні з редактора (або оболонки) на веб-сторінку та назад.
• Отримати людина для перевірки правопису, граматики і змісту - це показує , що деякі зусилля пішли в створенні статті виправити і легко читати. Якщо нікого немає навколо, обов’язково перечитайте всю статтю перед публікацією.
• Якщо платформа для блогів має підсвічування синтаксису , використовуйте її. Якщо ні, опублікуйте код де-небудь, де він є, і посилання там.
  • Висновок: тримайте величезні шматки коду далеко від тексту статті. Це трохи розпливчасто, але якщо текст пояснює, як працює якийсь код, добре включити фрагмент. Якщо він пропонує фрагмент програмного забезпечення для завантаження, краще звернутися до веб-інтерфейсу VCS.
• Кожна стаття повинна бути читаною самостійно . Посилання на інші статті чудово, але не слід вважати, що читач читав будь-які інші публікації до цього.
• Використовуйте інші формати, крім тексту, коли вони сприяють розумінню. Для деяких речей код достатній, але для деяких зображень або навіть анімації може бути набагато зрозуміліше.

Часто я знаходжу, що важка публікація в блозі займає стільки часу, оскільки вона потребує досліджень; це дослідження не просто допомагає вашій публікації блогу, але допомагає вам формувати свої власні особисті знання в процесі. Як ви сказали, ви зміцнюєте знання, написавши пост; ви також розширюєте свої знання. Прийміть потрібний час і оцініть це як досвід навчання.

Так, звичайно, щоб написання технічного блогу займало час. Для мене написання займає найкоротший проміжок часу (короткий, як година, або до дня, залежно від тривалості). Тоді редагування та перезапис зазвичай займають більше часу (до двох, а то й трьох днів). Ще один аспект, про який було сказано, який потребує часу, - це уточнення будь-якого зразкового коду. Також мені подобається витрачати час на пошук посилань на мою тематику. На це потрібен час!

Я думаю, ви можете писати технічні блоги зараз, але я б запропонував вам зробити це, коли ви станете експертом у якійсь конкретній галузі. Провести вихідні не здається занадто багато часу. все залежить від складності теми. Я думаю, що я говорю, що серцевина вашої ідеї здригається, природно, Виконання може (і буде) зайняти більше часу.

Люди шукають консультації експертів у своєму блозі. але я говорю в загальному сенсі .. Я не хочу перешкоджати вам писати блоги. Але пам’ятайте про наступні речі.

1. Ваш блог повинен сказати щось нове. Не просто збирайте дані та розміщуйте їх у власному блозі

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

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

4. Вивчіть техніку написання блогів (точність, стислість тощо)

5. Напишіть щось, оскільки ви думаєте, що це має бути написано; не тому, що ви думаєте, що це буде прочитано.

Елементи стилю

Я думаю, що технічне написання дотримується майже тих же правил, що і будь-яке написання. Якщо ви читаєте лише одну книгу про написання, це має бути класичний Стрункс "Елементи стилю" . Він проходить перелік речей, які покращать ваш склад, головне - ІМО, "Пропустіть непотрібні слова".

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

Якщо говорити важко про технічне написання, це не власне написання, а роз'яснення ваших думок щодо того, про що ви пишете. Помутніння мислення призводить до поганого письма. Гарне письмо вимагає від вас чіткого розуміння вашої теми, саме тому викладання та письмовість є таким чудовим способом оволодіння предметом.

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

Це вимагає часу, але якщо це ціна написання чогось, чого я не соромлюсь згодом, я вважаю, що це того варто.