Дисклеймер: это продолжение темы о составлении правильной технической документации. В первой статье мы рассказали, какие цели преследуются при составлении инфраструктурной документации и какие у нее особенности. А теперь поговорим о том, как составить годный стайлгайд, чтобы
Продолжая тему использования Asciidoc (и других аналогичных форматов) для организации процессов непрерывного документирования, хочу рассмотреть тему автоматический генерации технической документации. Автоматическая генерация документации — распространенный, но очень расплывчатый термин. Я понимаю под этим термином извлечение для представления в удобном виде информации, содержащейся в исходном коде и настройках документируемой программы (информационной системы). Читать дальше →
Максим Кулагин, руководитель технической поддержки C3D Labs, делится секретами предоставления эффективной технической поддержки и объясняет, как правильно создавать запросы.Если говорить об отделе технической поддержки в терминах информационных технологий, то он представляет…
Всем привет, меня зовут Динара! В компании Бимэйстер я являюсь Старшим техническим писателем и хочу рассказать немного о правилах оформления технической документации.ВведениеВ ИТ-компаниях не сразу пришли к тому, что нужен технический писатель, а про нормоконтроль вообще не…