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

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

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

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

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

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

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

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

По какому принципу делается любая пояснительная записка, какая информация там должна быть, где ее взять - было здесь. Теперь разберемся, как уложить добытую информацию в документ: как организовать структуру документа в зависимости от того, для какого объекта делается пояснительная записка. Для этого мы будем использовать требования Российских стандартов. Существует несколько систем ГОСТ, в которых приведены требования к пояснительным запискам: 1. Пояснительная записка программы делается в соответствии с единой системой программной документации (ГОСТ 19, ЕСПД)...

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

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

или как проходят собеседования на вакансию "Технический писатель". Побывав на нескольких таких собеседованиях, могу выделить общие моменты, которые происходят независимо от специфики компании. Не будем уделять внимание той части, где задает вопросы HR-специалист. В данном контексте это неинтересно. Начнем сразу с момента, где происходит уже следующая часть отбора кандидатов на вакансию - общение с руководителем подразделения, в которое ищут специалиста. Во время такого общения либо дают задание,...

О том, что в проектной документации внизу листа есть такие прямоугольные таблички, где что-то написано, знают все. Эти таблички (в простонародии - "штампы", по-научному - "основные надписи") отчасти и делают документацию проектной. А о том, откуда взялись эти штампы, почему они именно такие, почему в разных документах эти штампы выглядят по-разному, знают только те, кто потратил время и разобрался в этом. Как часто бывает в проектных организациях: более опытный товарищ делится с менее опытным шаблоном, в котором есть форматки (заготовки под все размеры листов с штампами)...