Книга Татьяны Анатольевны Макаровских представляет собой реферативную подборку материалов, посвященных документированию программных средств. Данное учебное пособие адресовано студентам по специальности «Прикладная математика и информатика». Книга будет полезна начинающим техническим писателям, работающим по ГОСТ, а также разработчикам программного обеспечения.
Полное название книги Т.А. Макаровских (Панюковой):
Документирование программного обеспечения: в помощь техническому писателю. М., 2023.
Книга состоит из трех частей. Первая часть посвящена описанию процесса документирования и работы технического писателя. Вторая часть – российским стандартам и различным видам программной документации. В книге приведен пример технического задания на проектирование электронного ресурса. Освещаются управление версиями, управление сборками, а также понятие baseline (последняя базовая целостная версия продукта разработки: кода, документации и т.д.).
Третья часть книги посвящена программным средствам разработки документации. В книге рассматриваются теоретические основы технологии единого источника, платформа DocBook/XML. Описываются системы разработки технической документации MadCap Flare и Arbortext. Разбираются их достоинства и недостатки по сравнению с платными и бесплатными текстовыми процессорами. Приводятся полезные рекомендации по работе с большими документами в MS Word. В частности: рекомендации по использованию стилей, рисунков, заголовков списков и т.д.
Несмотря на то, что часть ссылок в списке литературы с течением времени стала неактуальной, данная книга переиздается ежегодно более десяти лет подряд. Она хорошо дополнит книгу В.А. Глаголева «Разработка технической документации: руководство для технических писателей и локализаторов ПО» и будет полезна начинающим техническим писателям.
