AuthorIT и Confluence

Что такое AuthorIT™ — знает любой технический пейсатель. Что такое Atlassian Confluence™ — каждый, кто когда–либо пытался организовать командную работу в заведении, в интересах которого он трудится в поте лица, не покладая рук и не щадя живота своего. Тема статьи — автоматизация разработки технической документации в рабочих группах или проектных командах, причем применительно только к AuthorIT и Atlassian Confluence, — профессиональному средству документирования и инструменту, подающему осторожные надежды.

Были проведены сравнительные или даже исследовательские испытания, результаты которых могут представлять определенный интерес для разработчиков. Developer'ы же тихо–молча покидают раздел и отправляются на хакатон, создавать там скиллы 🤣 FrameMaker, Robohelp и безвременно ушедший от нас проект Syntext Serna не рассматриваются, но не «потомУ, что», а «потому, ЧТО».

Командирским решение все, что связано с AuthorIT™ и Atlassian Confluence, перенесено в раздел автоматизации документирования. Редакция от 09.12.2024.

View Issue Link Types — Jira — попытка привести в порядок и сопоставить связи между задачами (работами проекта) в структуре декомпозиции работ проекта. И в модульных декомпозициях тоже. Редакция от 18.12.2024.

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

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

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

После тщательного пересмотра книга «Автоматизация разработки технической документации с применением AuthorIT. Учебное пособие» вернулась на свою историческую родину — https://authorit.ru. Обновленная версия доступна в режиме онлайнового просмотра, изначальная — по указанной выше ссылке. Редакция от 17.12.2024.

Связывание задач Jira со страницами Atlassian Confluence не несет в себе ничего принципиально нового. Кроме того, что ранее в Jira импортировали 95 задач, а в Atlassian Confluence — ровно столько же разделов, подразделов, пунктов и подпунктов документа в виде отдельных страниц, каждая из которых взаимно–однозначно соответствует одной–единственной задаче.

В поле Description каждой задачи имеется ссылка, позволяющая мгновенно разыскать «еёйную» страницу, чтобы затем связать задачу и страницу, как показано на рисунке ниже. Редакция от 09.11.2024.

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