Клуб технических писателей и просто читателей

Техническая документация без схем - как театр без декораций: слова есть, картинок нет. Поэтому техническому писателю важно уметь составлять схемы к тексту. Схемы - самый древний способ планирования, изобретённый человеком. Наскальная живопись наших предков - это тоже схемы. Первые схемы выглядели довольно лаконично. Кружок - пещера, зиг-заг - речка или огонь, стрелка - направление пути к мамонту. Такой первобытный навигатор. Такие схемы мог понимать только тот, кто рисовал и присутствовал при отрисовке...

Дорогие коллеги и просто читатели. Часто встречаю путаницу в терминологии, когда речь идет об API и SDK. У многих нет понимания того, когда правильно писать/говорить API (application programming interface), а когда - SDK (software development kit). В этой статье хочу прояснить, в чем разница и когда какой термин нужно применять. Чтобы сразу стало понятней, в чем суть путаницы, приведу несколько примеров: Зафиксируем первую основную мысль: API - это часть SDK. Многие называют API, подразумевая под этим SDK и наоборот - говорят про SDK, хотя имеют ввиду API...

С появлением нейросетей у тех, кто занимается документированием, появился серьезный конкурент. Нейросети пишут тексты порой лучше и быстрее, стоит только правильно сформулировать промпт. А в скорости анализа большого объема информации человек вообще беспомощная букашка в сравнении с нейросетью. Попробовав работать с нейросетью, внедрив ее в свой рабочий процесс, мне слабо верится, что ИИ сможет полностью заменить технического писателя. Почему я так считаю: 1. Текст из ИИ - не всегда решение задачи "под ключ"...

Многие знают про то, что в Word можно создать оглавление автоматически. Но иногда можно столкнуться разными "глюками", такими как: Что ж, мы принимаем этот вызов и разберёмся, как это "лечится". Итак,...

В этой статье будут описаны распространённые ошибки форматирования документа MS Word с помощью стилей и приведён проверенный метод создания надёжных шаблонов, основанных на стилях. Этот метод никогда меня не подводил на протяжении уже более 10 лет. Те шаблоны, которые были созданы много лет назад в более старых версиях MS Word при помощи такого метода, так же хорошо работают и в новейших версиях этого текстового редактора. Итак, когда мы пытаемся привести в порядок текстовый документ, используя стили,...