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

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

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

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

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

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

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

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

AuthorIT и Confluence при разработке технической документации

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

Были проведены сравнительные или даже исследовательские испытания, результаты которых могут представлять определенный интерес для разработчиков. Developer'ы же тихо-молча покидают раздел и отправляются на хакатон, создавать там скиллы - Ржунимагу! (смайл) FrameMaker, Robohelp и безвременно ушедший от нас проект Syntext Serna не рассматриваются, но не «потому, что», а «потому, что».

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

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

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

Автоматизация разработки ТД с применением инструментария на основе single source

Разработка изделий, программных изделий, создание автоматизированных систем сопровождаются разработкой технической документации (ТД) - так было, есть и будет. Но для множества компаний разного «калибра» разработка ТД остается занятием рутинным, трудоемким и ресурсоемким, а результаты - сомнительными. Причины понятны, выход - в автоматизации разработки технической документации. Редакция от 13.03.2021.

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

Статья «Автоматизация разработки технической документации. Часть I» от 22.01.2005 г. открыла принципиально новые практические приемы разработки техдокументации. На основе первого (в нашей стране) успешного опыта автоматизации документирования показаны предпосылки к автоматизации жизненного цикла техдокументации. Да и вообще: любая автоматизация позволяет решить большинство проблем организационного характера техническим путем. Редакция от 13.03.2021.

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

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

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

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

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

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

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

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

Страницы

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

Яндекс.Метрика