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

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

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

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

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

    (2) Назначение и цели создания (развития) системы

    (2) Назначение и цели создания (развития) системы

    Назначение и цели создания (развития) системы - основополагающий раздел технического задания на автоматизированную систему, разрабатываемого согласно ГОСТ 34.602. Как элемент иерархической структуры техзадания раздел занимает наивысший уровень иерархии. В документах раздел выделяетсянумеруется), как правило, заголовком 1-го уровня. От того, насколько четко сформулированы цели и задачи в содержимом данного раздела, всецело зависит ход дальнейшей разработки. Редакция от 06.01.2022.

      Что такое интуитивно-понятный интерфейс?

      Что такое интуитивно-понятный интерфейс?

      Словосочетание интуитивно-понятный интерфейс, встречающееся практически во всех нынешних техзаданиях, на людей технически грамотных действует как красная тряпка на быка. Это вполне объяснимо: во время оно, когда ГОСТы были обязательны к применению, подобную чушь вычитать где-либо было нереально. И естественна реакция этих людей - а где же тогда требования к пользователю такого «интуитивно-понятного» интерфейса в части его (пользователя) понятливости и интуиции?! Решим вопрос интуитивно-понятного интерфейса раз и навсегда 😃 Редакция от 07.12.2023.

        Урегулирование разногласий и разрешение споров между заказчиком и исполнителем

        Урегулирование разногласий и разрешение споров между заказчиком и исполнителем

        Урегулирование разногласий и разрешение споров между заказчиком и исполнителем (разработчиком) для достижения «взаимного согласия как продукта при полном непротивлении сторон» или (в крайнем случае) консенсуса как новое направление деятельности «Техническая документация». Редакция от 03.02.2023.

          Что такое автоматизированная система? Часть I - состав в картинках

          Что такое автоматизированная система? Часть I - состав в картинках

          Первая статья цикла, посвященного автоматизированным системам (АС). АС представлена в виде многоуровневой графической иерархической структуры, структура автоматизированной системы и применяемая в ГОСТ 34.003-90 терминологическая система прокомментированы на языке, доступном для понимания всем тем, кто уже научился читать. Цикл статей подготовлен совместно с к.т.н. Казанцевой Е. Б. Редакция от 13.01.2022.

            Рерайтинг в техническом документировании, или делайте это с блеском!

            Рерайтинг в техническом документировании, или делайте это с блеском!

            «Рерайтинг (rewriting) - переписывание чужого текста своими словами. Специалистов по лексическому изменению оригинальных текстов называют рерайтерами. Рерайтинг используется для того, чтобы изменить входящий текст до уровня оригинального текста. Услуга востребована в условиях лавинообразного наполнения Интернета все новыми сайтами и наполнения контентом уже имеющихся сайтов...» Это из всеми любимой Педевикии. А возможен ли рерайтинг - да еще и блестящий - в техническом документировании? Это стало бы настоящим подарком от Гифмарт для настоящего мужчины 😀 Редакция от 30.04.2021.

              Что такое интеграция автоматизированных систем (АС) на основе XML

              Что такое интеграция автоматизированных систем (АС) на основе XML

              Интегрированию автоматизированных систем (АС), как и интеграции на основе XML в целом, посвящено великое множество наукообразных и (или) околонаучных статей, всевозможных intuitru'шных курсов обучения и т.п. Но зачем же выносить публике остатки мозга и без того облегченного американского полевого образца? Жизнь хороша, когда пьешь не спеша, и все очень просто, когда знаешь ГОСТы 😉 Просто и ясно об интеграции автоматизированных систем на основе XML как автономные системы видеонаблюдения. Редакция от 13.01.2022.

                Кастомные переменные в Drupal 8

                Кастомные переменные в Drupal 8

                Кастомные (в пользовательском контексте) переменные в Drupal 8 могут применяться для хранения и представления исходных (вводных) данных проекта, в состав которых входят наименование проекта, наименование продукта проекта, даты инициации и завершения проекта, заказчик, руководитель, куратор, все заинтересованные стороны, все участники проекта и многое-многое другое, в том числе параметры ссылок на внешние системы управления проектами (вроде Jira или Redmine).

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

                  Клонирование сущностей через экспорт-импорт

                  Клонирование сущностей через экспорт-импорт

                  Клонирование сущностей от проекта к проекту разумнее всего выполнять экспортом (безотносительно ГИС) предыдущего проекта с «последующим импортом последующего» 😂 Т.е. вновь создаваемого. Если, конечно, последующий проект представляется более-менее типовым.

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

                    Таксономия входимости

                    Таксономия входимости

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

                    Петя и Вася, а ЗАЧЕМ?! Ведь можно ВНЕДРИТЬ фрагмент первоисточника и в книжку, и в монографию, избавив пытливого читателя от шараханья по библиографическим ссылкам, а себя от копипастинга? При этом к внедренному фрагменту автоматически прикрутятся ссылки на точки входа фрагмента в структуры первоисточника, книжки и монографии?

                    Это легко, если использовать авторскую такономию входимости. Редакция от 18.01.2022.

                      Страницы

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