Вопросы документирования

16.10 ГОСТ 2.610-2006

16.10 Для обеспечения ясности изложения информации, содержащейся в ИЭД, необходимо соблюдать следующие принципы:

  • важную значимую информацию давать в виде описательного текста;
  • когда описательный текст приводится совместно с графикой, для сокращения текста необходимо:
    • устранить все междометия,
    • начинать предложения с переходных глаголов,
    • по мере возможности применять повелительное наклонение;
    • если нужно указать условие, предложение должно начинаться со слова «когда» (...когда напряжение питания стабилизируется...) и т.д.;
  • не рекомендуется использовать сложноподчиненные и сложносочиненные предложения. Длинные параграфы или предложения необходимо разбивать на части;
  • средняя длина предложения не должна превышать 20 слов. Средний абзац не должен превышать шесть предложений. Каждый абзац, по возможности, должен иметь заглавное или основное предложение, весь материал в абзаце должен быть по этой теме;
  • за исключением особых обстоятельств, следует строить объяснение операций с максимальным использованием графических и мультимедийных возможностей;
  • описательный текст следует давать в логической последовательности выполнения работы;
  • описательный текст должен быть выдержан в единой терминологии, едином стиле и формате во всем ИЭД;
  • при описании работы устройств, имеющих обозначения на их собственных панелях управления, их следует называть только по именам, указанным на панелях. При необходимости допускается использование дополнительного комментария;
  • диалоги должны быть организованы таким образом, чтобы выполнение последующих действий было бы возможным только после ввода ответа пользователя. Информация должна быть представлена в базе данных ИЭД таким образом, чтобы после вывода сообщения на экран и получения ответа можно было бы произвести анализ ответа, определить потребности пользователя и предоставить ему необходимые данные.

[из 16.10 ГОСТ 2.610–2006]

    Из ГОСТ 18675-2012 Документация эксплуатационная и ремонтная на авиационную технику и покупные изделия для нее

    Из ГОСТ 18675-2012 Документация эксплуатационная и ремонтная на авиационную технику и покупные изделия для нее

    ГОСТ 18675—2012 Документация эксплуатационная и ремонтная на авиационную технику и покупные изделия для нее. Design documentation for aircraft and furnished equipment operation and maintenance. УДК 629.7.004:002:006.354 МКС 01.100.10 Д01. Редакция от 03.11.2023.

      Из ГОСТ 2.601-2013 Единая система конструкторской документации. Эксплуатационные документы

      Из ГОСТ 2.601-2013 Единая система конструкторской документации. Эксплуатационные документы

      ГОСТ 2.601–2013 Единая система конструкторской документации. Эксплуатационные документы. Unified system for design documentation. Exploitative documents. УДК 62(084.11):006.354 МКС 01.100 Т52 ОКСТУ 0002. Редакция от 08.02.2024.

        Из ГОСТ Р 54088-2017 Интегрированная логистическая поддержка. Эксплуатационная и ремонтная документация в форме интерактивных электронных технических руководств. Основные положения и общие требования

        Из ГОСТ Р 54088-2017 Интегрированная логистическая поддержка. Эксплуатационная и ремонтная документация в форме интерактивных электронных технических руководств. Основные положения и общие требования

        ГОСТ Р 54088–2017 Интегрированная логистическая поддержка. Эксплуатационная и ремонтная документация в форме интерактивных электронных технических руководств. Основные положения и общие требования. Integrated logistic support. Operating and maintenance documentation in interactive electronic technical manuals format. General provisions and general requirements. УДК 006.1:006.354 ОКС 01.040.01. Редакция от 05.03.2024.

          Из ГОСТ Р 58049-2017 Перевод эксплуатационной документации на изделия авиационной техники с (на) иностранные языки. Общие положения

          Из ГОСТ Р 58049-2017 Перевод эксплуатационной документации на изделия авиационной техники с (на) иностранные языки. Общие положения

          ГОСТ Р 58049—2017 Перевод эксплуатационной документации на изделия авиационной техники с (на) иностранные языки. Общие положения. Operational documentation translation of aviation equipment items from/into foreign languages. General provisions. УДК 81.33:006.354 ОКС 49.020 01.020 01.110. Редакция от 19.11.2023.

            Из ГОСТ Р 58182-2018 Требования к экспертам и специалистам. Нормоконтролер технической документации. Общие требования

            ГОСТ Р 58182-2018 Требования к экспертам и специалистам. Нормоконтролер технической документации. Общие требования

            ГОСТ Р 58182–2018 Требования к экспертам и специалистам. Нормоконтролер технической документации. Общие требования. Requirements for experts and specialists. Engineering documents normocontrol. Basic principles. УДК 006.05:006.354 ОКС:03.080.20. 03.100.30. Редакция от 07.03.2024.

              Из ГОСТ Р ИСО 11442-2014 Техническая документация на продукцию. Управление документацией

              Из ГОСТ Р ИСО 11442-2014 Техническая документация на продукцию. Управление документацией

              ГОСТ Р ИСО 11442-2014 Техническая документация на продукцию. Управление документацией. Technical product documentation. Document management. УДК 005.92:006.354 ОКС 01.110; 35.240.10. Редакция от 02.04.2022.

                Из ГОСТ Р МЭК 62023-2016 Структурирование технической информации и документации

                Из ГОСТ Р МЭК 62023-2016 Структурирование технической информации и документации

                ГОСТ Р МЭК 62023—2016 Структурирование технической информации и документации. Structuring of technical information and documentation. УДК 658.52.011.56 ОКС 29.020 IDT. Редакция от 10.12.2023.

                  Подписка на Вопросы документирования