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

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

Создан 15.08.2019 14:02:20

И долго буду тем любезен я народу...

автора автор запамятовал

- AuthorIT и Confluence - выбор концепции

Итак, имеется заказчик, представленный высшим (или не очень) руководством, обладающим правами и полномочиями по принятию решений. У заказчика имеется некий персонал, что-то пишуший в рамках текущих проектов.

Не вызывает никаких сомнений то, что организация документирования пущена на самотек и представляет собой откровенный бардак, см. Техническая документация: типичная реализация жизненного цикла. Автор не поленился с середины июля по середину августа 2019 г. посетить четыре или пять достаточно солидных заведений (чьи бренды на слуху) и в очередной раз убедился, что проблемы с документированием у всех одни и те же. Были, есть и будут 🤣 Многие уже давно осознали то, что техническое документирование с применением Microsoft™ Word - это опаснейшая трясина!

В прекращении этого бардака (или попытках его возглавить) заинтересованы: высшее руководство, уставшее пинать техписунов, измученных Microsoft™ Word, и сами техписы, поскольку именно они являются конечным звеном пищевой цепочки, которой перепадают совсем уж крохи от общего пирога, зато люлей - хоть отбавляй. Будет ли вовремя сдан-принят проект - во многом зависит от качества документации, а не только от сумм откатов.

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

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

«Трансфер» возможностей AuthorIT 4.5 Desktop Edition в Confluence в части технического документирования

- «Трансфер» возможностей AuthorIT 4.5 Desktop Edition в Confluence в части технического документирования

«Трансфер» возможностей AuthorIT 4.5 Desktop Edition в Confluence в части технического документирования изображен на рисунке. Простая логическая схема 2И. А дальше - на усмотрение заказчика. Заказчик может:

  • не привлекать автора к дальнейшему сотрудничеству. В этом случае он получает импортированную в Atlassian Confluence библиотеку взаимоувязанных документов по ГОСТ 19 и (или) 34, но вся дальнейшая ответственность ложится непосредственно на него и его персонал. Поработали совместно, рассчитались и расстались друзьями;
  • привлекать автора к дальнейшему сотрудничеству. В этом случае заказчик сможет периодически импортировать в Atlassian Confluence обновленные версии библиотек, причем на выбор - с заменой (перезаписью) уже существующего контента Atlassian Confluence или без нее;
  • привлекать автора к дальнейшему сотрудничеству по конкретным проектам. Тогда автор станет сопровождать проекты заказчика и актуализировать документы с учетом текущих пожеланий разработчиков и пишущей братии, а дружба продлится на веки вечные.

Результаты налицо. Любой из перечисленных вариантов взаимовыгоден:

  • заказчик обретает возможность подготовки документации предельного качества из единого контентного источника (исходника) с применением стандартных шаблонов оформления;
  • пищущие не менее счастливы - не придется ничего копипастить в десятки различных документов, структуры документов проекта в Atlassian Confluence изначально стандартизованы, общие топики заранее взаимоувязаны. Правишь один документ - автоматически-синхронно правятся все связанные. Божья благодать;
  • доволен и автор. С каждым новым проектом кругозор становится все шире и шире 🤣

В итоге у всех все хорошо: и волки (руководители) сыты, и овцы (техписы) целы, а пастух долго еще будет тем любезен...

А теперь, пожалуй, можно перейти к технической стороне вопроса - сравнить функциональные возможности AuthorIT Workgroup Edition 4.5 и Atlassian Confluence в части технического документирования.