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

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

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

    Связывание задач Jira со страницами Confluence

    Связывание задач Jira со страницами Confluence

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

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

      Пакетный импорт задач в Jira

      Пакетный импорт задач в Jira

      Пакетный импорт — он же импорт задач в Jira в режиме пакетной обработки — это дело серьезное. В статье Создание задач Jira с помощью внешних ссылок было показано, как создавать задачи (они же issues) в Jira поодиночке с помощью гиперссылок, но это все для любителей садомазо и ради констатации самого факта, что создавать одиночные задачи можно не только с помощью интерфейса самой Jira, но и с внешних ресурсов (да хоть из текста стандарта, открытого в документе Microsoft™ Word), прописывая в гиперссылках необходимые параметры. Но ни один вменяемый руководитель проекта, разработки или главный конструктор ОКР не...

      И тут автор сам себя поймал на вранье 🤪 Подавляющее большинство участников проектов любой степени сложности в нашем благословенном государстве занимается именно тем, что вводит задачи Jira, Redmain, Bitrix24 или MS Project вручную. Покажем, как автоматически и всего за несколько минут создать в Jira сразу аж целых 95 задач, причем полностью соответствующих требованиям стандарта. И заполучить на выходе красивую диаграмму Гантта, изображенную на рисунке ниже. Редакция от 22.12.2024.

        Создание задач Jira с помощью внешних ссылок

        Создание задач Jira с помощью внешних ссылок

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

          Гиперссылки в AuthorIT как путь в матрицу

          Гиперссылки в AuthorIT как путь в матрицу

          Гиперссылки в AuthorIT бывают разные, но в большей степени мощные и разнообразные, см. рисунок ниже. Если классическая гиперссылка на нечто предполагает всего лишь одну ссылку на это нечто, к примеру, статью на сайте, как все в данном абзаце, то...

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

          Для чего вся эта затея? А чтобы попасть в матрицу 🤪 Редакция от 04.04.2021.

            Юникоды (unicode) в гиперссылках (hyperlink)

            Юникоды (unicode) в гиперссылках (hyperlink)

            Юникоды (unicode) в гиперссылках (hyperlink) — это дело серьезное. Если не полениться и открыть страничку Общие положения [из разд. 1 ГОСТ 19.201–78], можно легко в этом убедиться. Часть гиперссылок на ней выполнена текстом (Гантт), подавляющая — картинками (- Задача в Jira), а кое–что — юникодами (🆕 ✅ 🔗). И все вроде ничего, но:

            • если в каждой гиперссылке будет содержаться слово Гантт (а еще Открыть, Создать и тому подобное), то текст страницы будет настолько заспамлен этими словечками, что поисковики «за деревьями не увидят леса» — основной тематики страницы. И снизят ее рейтинг в поиске. Поэтому иконки и пиктограммы — и только они;
            • при этом создание множества различных гиперссылок с одинаковыми картинками — занятие муторное и дезориентирующее — сходу и не разобраться, какой ссылкой какая иконка «обернута», а по сему —
            • только символы юникода!

            Это дешево, надежно и практично, а делается легко и просто, см. ниже. Редакция от 09.11.2024.

              Страшная правда о техническом задании

              Страшная правда о техническом задании

              Техническое задание — страшный, коварный и очень подлый документ. При грамотно проведенной разработке ТЗ становится мощнейшим инструментом манипуляций как заказчиком, так и исполнителем. Вопрос лишь в том, кто из них окажется умнее. Такова c est la vie — либо се ля вы, либо се ля вас... Впервые опубликована в журнале «Мир Автоматизации» № 4 за 2006 год под названием «Ваш выбор? Часть II». Редакция от 07.12.2024.

                Как описать графический интерфейс пользователя?

                Как описать графический интерфейс пользователя?

                Приемы описания графического интерфейса пользователя. Впервые опубликована 09.03.2005 года под названием «Графический интерфейс пользователя». За весь срок своего существования статья уверенно удерживает 2 место в рейтинге просмотров, уступая лишь циклу статей к.т.н. В. А. Глаголева о стоимости разработки техдокументации. Редакция от 09.12.2024.

                  Улучшение навигации в бумажных документах с применением AuthorIT

                  Приемы улучшения навигации в бумажных документах (и в их исходных электронных версиях) с учетом требований ГОСТ 2.105 с применением AuthorIT. Отмечено автоматическое улучшение ряда оценочных факторов удобства применения по ГОСТ 28195–89. Редакция от 12.12.2024.

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

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

                      Страницы

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