Взаимоувязанный

Библиотеки взаимоувязанных документов для Atlassian Confluence

Пришло время освежить эту статью, включая ее название. Библиотеки взаимоувязанных документов для AuthorIT безусловно полезны тем, кто пользуется программой AuthorIT для разработки технической документации. Но таких счастливцев, к сожалению, найдется немного, а счастливчиков - владельцев AuthorIT Workgroup Edition - и того меньше. Поэтому речь пойдет о замене инструмента, редкого и относительно дорогого AuthorIT, на широко распространенный и практически бесплатный Atlassian Confluence путем воспроизведения последним функциональных возможностей первого.

Кому все это надо? В явном виде тем, кто непосредственно занимается писаниной, в неявном - ВООБЩЕ ВСЕМ участникам проекта, даже заказчику. Ведь ни для кого не секрет, что без громадного количества бумаги не обходится ни один даже самый простенький проект. Редакция от 16.03.2021.

Библиотеки взаимоувязанных документов при обратной разработке (reverse engineering)

Библиотеки взаимоувязанных документов представляют особый интерес при обратной разработке. И не только - библиотеки взаимоувязанных документов позволяют документировать с самых различных «точек входа», с любой стадии или этапа жизненного цикла.

Обратимся ко всеми любимой педевикии, поскольку стандарты всегда несколько отстают от образования некоторой сущности или «новой формулы». Итак, «Обратная разработка (обратный инжиниринг, реверс-инжиниринг; англ. reverse engineering) - исследование некоторого изделия или программы, а также документации на него с целью понять принцип его работы и, чаще всего, воспроизвести устройство, программу или иной объект с аналогичными функциями, но без копирования как такового.». И начнем воспроизводить. Редакция от 13.03.2021.

Подготовка взаимоувязанных документов к импорту в Confluence

Для импорта взаимоувязанных документов из библиотек из AuthorIT Workgroup Edition в Atlassian Confluence необходимо провести некоторые подготовительные операции. Автор заранее подготовил, вернее, «подчистил» пару боевых документов из проекта так, чтобы они были небольшими по объему и быстро импортировались в Atlassian Confluence, но при этом содержали «пересекающиеся», т.е. общие топики в структуре каждого из документов. На картинках общие топики отмечены значком . Редакция от 13.03.2021.

Copyright © «Техническая документация» 2008-2021. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.