Техническая документация

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

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

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

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

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

Создание задач Jira с помощью внешних ссылок - занятие полезное. Ведь одно дело - жать на кнопки довольно тормознутого интерфейса самой Jira, а совсем другое дело - единожды щелкнуть по ссылке из какой-нибудь тематической базы знаний, к примеру, создать задачу 1.1.2 Сбор исходных материалов (🔍, ✅) непосредственно из ГОСТ 19.102-77. И потом, когда какой-нибудь охламон из особо «эффективных» или военпред из генеральских сыночков поинтересуется, откуда в плане проекта взялась такая задача и почему она бешено сжирает ресурсы, можно будет ткнуть в обратную ссылку и показать, что это требование конкретного стандарта. Таким образом, создание задач Jira внешними ссылками из авторитетных источников полностью и целиком обосновывает все действия «создателя» и исключает возможность предъявить какие-либо претензии ко всей его деятельности. Редакция от 24.08.2020.