Автоматизация разработки технической документации

- Автоматизация разработки технической документации

Автоматизация разработки технической документации и документирования в целом. Автоматизация документирования - не просто избавление от средневековых операций «copy-paste» и многократное повторное использование текстов, графики, мультимедиа и гиперссылок, а инновация в прямом смысле этого слова, прорыв в светлое будущее, если светлое будущее в этой стране возможно принципиально Редакция от 24.08.2020.

Существующий инструментарий на основе single source и библиотеки взаимоувязанных документов, впервые разработанные в 2004 году, обладают сверхмощным потенциалом. Так, к примеру, вполне решаемой задачей видится приведение в порядок всей системы стандартизации в стране, всей законодательной базы и пр. Все дело в заинтересованности компетентных надзорных и ответственных органов .

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

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

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

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

Библиотеки взаимоувязанных документов для (AuthorIT - зачеркнуто) Atlassian Confluence

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

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

Автоматизация навигации на сайте с применением AuthorIT

Тот, кто занимается подготовкой содержимого (контента), знает, что навигацию на сайте можно организовать «дружественнее» ссылками на конкретные места (якоря) в страницах, а не на страницы в целом. Вручную это трудно. Как автоматизировать создание таких ссылок и существенно улучшить навигацию по сайту? Редакция от 14.08.2020.

Внесение изменений в общий топик и экспорт документов из Confluence в MS Word

Экспорт взаимоувязанных документов из Atlassian Confluence в Microsoft™ Word выполняется из текущего рабочего пространства выбором пункта из того же меню, что использовалось для импорта, только Export to Word, см. рисунок из подраздела Импорт документов из Microsoft™ Word в Atlassian Confluence. Но сначала следует внести изменение в любой из общих топиков, чтобы совсем уж было очевидно, что библиотека взаимоувязанных документов, сформированная в предыдущем подразделе, реально работает. Редакция от 13.08.2020.

Выбор автора - «это очень хорошо и большим и детям»

Автор столь же бескорыстно любит новые знания, сколь котенок сосиски. Поэтому выбор концепции для него очевиден - это вариант пять. Тем более, что данный вариант концепции способен удовлетворить всех: и заказчика с его «пописывающим» персоналом, и исполнителя в лице автора. AuthorIT Workgroup Edition 4.5 во владении автора и Atlassian Confluence в защищенной и доступной извне (автору) сети заказчика - «это очень хорошо и большим и детям» Попробуем все сказанное разъяснить словами. Редакция от 13.08.2020.

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

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

Чем замечателен AuthorIT?

Возможность или невозможность - это сущности одного порядка. Все функциональные возможности любого программного продукта вряд ли кем применяются (да и вообще - кем-либо изучены), интересен лишь функционал, необходимый и достаточный для конкретной предметной области деятельности - для технического документирования, а также выявленные ограничения функционала. Рассмотрим их в рамках имеющегося практического опыта применения AuthorIT Workgroup Edition 4.5 (15-летнего) и Atlassian Confluence (трехнедельного). Редакция от 13.08.2020.

AuthorIT и Confluence - варианты концепций

Главное - не думать об этом, все уже приумано до нас. Открываем Стадии и этапы создания АС по ГОСТ 34.601-90 и смотрим, что уже сделано, а что предстоит. Получается следующее: AuthorIT и Atlassian Confluence инициативно уже поизучали в рамках инициативной же группы, пришли к определенным результатам, и даже в некототом смысле отчитались по ним в двух предыдущих разделах. Получается, что предстоит проработать варианты концепций применения AuthorIT и Atlassian Confluence, основываясь на полученных данных. Редакция от 13.08.2020.

AuthorIT и Confluence - надежность поставки и поставщика

По не вполне понятным причинам вопросам надежности всегда отдается первенство, см. хотя бы Требования к системе в целом по ГОСТ 34.602-89, хотя автор вполне обоснованно разместил бы безопасность «над усе». Ну или «uber alles» - кому что нравится Все дело в уровне человеколюбия Только надежность AuthorIT и Atlassian Confluence в данном подразделе будет рассматриваться не с классической точки зрения надежности в технике, а с позиции надежности поставок и поставщика, а безопасность - не в отношении персонала, а как безопасность информационная. Редакция от 13.08.2020.