Книга Татьяны Анатольевны Макаровских представляет собой реферативную подборку материалов, посвященных документированию программных средств. Данное учебное пособие адресовано студентам по специальности «Прикладная математика и информатика». Книга будет полезна начинающим техническим писателям, работающим по ГОСТ, а также разработчикам программного обеспечения.
Если вы ничего не знаете ни о технических писателях, ни о технической документации, эта книга для вас! Книга Михайлова А.В. идеально подойдет студентам-технарям или студентам-филологам выпускных курсов в плане выбора будущей профессии и применении на практике классического высшего образования. Если вы уже работаете техническим писателем, не покупайте эту книгу – вы зря потратите деньги и время.
Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документации: руководство для технических писателей и локализаторов ПО». Это компактный справочник, который позволит быстро разобраться в НИОКР, ГСИ, ЕСКД, ЕСПД, ЕСТД, КСАС и начать применять полученные знания на практике.
Наводя порядок в книжном шкафу, нашел книгу Максима Ильяхова и Людмилы Сарычевой «Пиши, сокращай: как создавать сильный текст». Я прочитал ее летом 2018 года, но отзыв для блога писать не стал. Сегодня, когда ажиотаж отзывов прошёл, кратко расскажу, какие советы из книги можно применить для работы над текстом пользовательской документации.
Уважаемые коллеги! Сегодня хочу рассказать вам о книге Уильяма Зинсера "Как писать хорошо". На первый взгляд, она не имеет ничего общего с разработкой справки и пользовательской документации. Но меня привлек подзаголовок "Классическое руководство по созданию нехудожественных текстов" и оказалось, что некоторые советы автора очень даже можно использовать при работе над своими текстами.
Илья Жуков
Технический писатель
EWriter — это формат справки и электронных книг для Windows от разработчика Help+Manual, компании EC Software. Несмотря на то, что формат EWriter не так популярен, как...
Читать полностью...
Книга Татьяны Анатольевны Макаровских представляет собой реферативную подборку материалов, посвященных документированию программных средств. Данное учебное пособие адр...
Читать полностью...
Если вы ничего не знаете ни о технических писателях, ни о технической документации, эта книга для вас! Книга Михайлова А.В. идеально подойдет студентам-технарям или ст...
Читать полностью...
Форматы электронной документации CHM, WebHelp и EWriter давно используются для создания и распространения электронных книг и учебников. Разработать такое учебное пособ...
Читать полностью...
Рисунки в проекте Help and Manual можно единообразно оформить тремя способами. Во-первых, это можно сделать в графическом редакторе, например в Impict. Во-вторых, для ...
Читать полностью...
При работе с форматами, основанными на HTML, для оформления контента в документах можно использовать каскадные таблицы стилей, cascading style sheets или CSS. Данная т...
Читать полностью...
Я по образованию филолог. Специализируюсь на разработке пользовательской документации на английском и русском языках. С формулами в документации сталкиваюсь редко и по...
Читать полностью...
Часто технический писатель получает исходные данные от аналитиков, разработчиков, тестировщиков, маркетологов и других специалистов в форматах DOC, DOCX и RTF (реже, и...
Читать полностью...
Во время поддержки проекта справки со временем ряд разделов устаревает. Вы исключаете их из сборки, возможно, даже удаляете из проекта. Собираете выходную документацию...
Читать полностью...
Понятие контекстной или контекстно-зависимой справки (от англ. context-sensitive help) появилось в 1987 году с выходом формата WinHelp. Изначально контекстная справка ...
Читать полностью...
Рисунки, схемы, скриншоты и другие изображения являются неотъемлемой частью любой пользовательской документации. Один скриншот с выносками может дать начинающему польз...
Читать полностью...
Уважаемые коллеги! Если вам нужно быстро освоить разработку документации по ГОСТ, рекомендую обратить внимание на книгу В.А. Глаголева «Разработка технической документ...
Читать полностью...
Выбрав русский язык и русскую кодировку в настройках проекта Help and Manual, многие авторы после первой сборки удивляются, увидев в выходных документах английские сло...
Читать полностью...
Разработчик справки в формате CHM может задать размер и расположение окна, которые будут использоваться при первом запуске CHM-файла. После того, как пользователь пере...
Читать полностью...
Многие платные редакторы скриншотов, например, SnagIt, FastStone Capture и др., умеют создавать эффект рваных краев. В сети Интернет можно найти множество видеоуроков ...
Читать полностью...
23 ноября 2022 года компания EC Software к 25-летнему юбилею выпустила 9-ю версию программного комплекса Help and Manual (выходит c 1997 года). Комплект шаблонов Premi...
Читать полностью...
Все о справке и документации для пользователей!
