Статьи

Что такое техническая документация? Часть II - понимаемое понятное понятие «понятности техдокументации»

Что такое техническая документация? Часть II - понятное понятие «понятности техдокументации»

Часто приходится слышать от заказчиков: «Нам надо не по ГОСТам, хотим, чтобы техдокументация была понятной». В первом приближении звучит как «Да, да! Сделайте нам красиво! В Большом театре нам постоянно делают красиво...». Но у нас не Большой с его вечными дрязгами: прагматики мы, а не креаклы, и творческая деятельность не по нашей кафедре. Покажем на практике, что понятная техдокументация разрабатывается только по ГОСТам, ведь само понятие понятности ГОСТировано. Редакция от 14.11.2021.

    Экспертиза техдокументации: как победить эксперта?

    Любая техническая документация как минимум согласовывается (заинтересованными сторонами) или подвергается экспертизе (к примеру, по схеме сертификации). Результат - записка или экспертное заключение с предложениями и замечаниями. После их учета и устранения документация утверждается и работа над ней завершается. Экспертизы проводят эксперты или как бы эксперты. Кто они, какова их роль и как их побеждать. Редакция от 30.04.2021.

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

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

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

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

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

        Страницы

        Подписка на Статьи