Содержание коротких технических статей

Инженерам иногда приходится писать инструкции, короткие технические статьи, готовить рассказы для презентаций и воркшопов, с объяснением того или иного рекомендуемого решения. При подготовке таких рассказов и статей сразу возникают вопросы: о чем писать, сколько писать, что рассказать, а что опустить.

У профессиональных писателей и редакторов есть шаблоны и заготовки текстов на различные темы. Попробуем собрать здесь ссылки на лучшие рекомендации в помощь тем, кто пишет технические статьи или рассказы.

Возможная структура "идеального" технического рассказа для воркшопа или статьи

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

Каким может быть каркас (структура) технической статьи или рассказа:

1. Технические проблемы, которые будут разобраны или решены в статье (или в рассказе на воркшопе).
2. Выбранные для решения инструменты, технологии или методики. На что опирались при выборе способов решения, какие метрики и целевые показатели для оценки итогов решения выбирали.
3. Описание того, как внедряли инструмент или реализовывали техническое решение. Расскажите о процессе решения, разработки инструмента, использовании технологии или методики.
4. Итоги внедрения: к чему пришли, оценка значений метрик и какая экономия получена.
5. Описание того, какие выявлены ограничения инструмента, технологии или методики в процессе решения.
6. Предложения, как можно улучшить и доработать предлагаемое решение в будущем.
7. Выводы, краткое резюме и основные мысли статьи или рассказа.

Приведём также один пример готовой структуры для написания вообще любой статьи (взято отсюда). Как пишет сам автор: "По ней можно написать пост, даже если вы считаете, что не умеете писать" :)

Полезные ссылки для подготовки технических статей, воркшопов и рассказов. Советы и сервисы

Сервисы:

1. Сервис Главред: проверит стилистику и грамотность текста.
2. The Rules: "Правила русского языка. Проверка орфографии и пунктуации".

Советы:

1. Как начать писать лучше? Главред: Советы и статьи о тексте, редактуре, информационном стиле и рекламе (см. раздел для начинающих).
2. Конечно же "Новые правила деловой переписки"
3. Рекомендации по подготовке презентаций и как готовиться к докладу: "Точка контакта: презентация".
4. DO IT INBOUND: "Готовая структура для разных типов статей"
5. "Как написать простое и понятное объявление".
6. Бюро: "Почему НЕ НАДО ПИСАТЬ КАПСОМ" и как лучше.