Коллеги, к несоответствию какому качеству документации можно отнести ситуацию, когда,

Question

Коллеги, к несоответствию какому качеству документации можно отнести ситуацию, когда,

мы должны дать ответ на один вопрос, а на самом деле отвечаем на другой, но ответ на этот другой вопрос правильный?

Например, вопрос: "Какие преимущества дает сервис?" А ответ приведен по сути на вопрос: "Как активировать сервис?"

Получается, нарушена фактологическая точность?

0

08.11.2023

16 ответов

26 просмотров

Olga S Автор вопроса

Maeg
это что-то про ISO?

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

0

08.11.2023

Maeg

Olga S
Нет. Это по каким критериям можно проверить технич...

соответствие заявленной теме, например

0

08.11.2023

Arina Ballerina

Судя по тому что вы рассказываете, факты там описаны правильно, но они не решают задачу пользователя. Поэтому это не неточность. Пока не приходит в голову, какое слово сюда подходит лучше всего. Но вопрос интересный.

0

08.11.2023

Andrei

Olga S
Нет. Это по каким критериям можно проверить технич...

Орфография и пунктуация это хорошо конечно, но не показывает главного, а есть ли вообще в природе то, на что написана документация или документация по сути перевод другой. Для железок как минимум, это соответствие и единообразие терминов и названий составных частей, плюс иллюстрации, чтобы это были не картинки с зафотошопленными названиями на английском или каком нибудь другом языке, а реальные иллюстрации из САПР, вещь если есть реальная разработка, то и 3d модели должны быть, а значит нормальные картинки. Другое дело, что если человек не владеет САПР, то ему придется выбивать это с разработчиков

0

08.11.2023

Arina Ballerina

Я думаю нарушена структура. В данном случае структура FAQ. Но может если копнуть глубже выяснится что назвать надо не следствие, а причину. Напрмер, ошибки сборки или что-то такое.

0

08.11.2023

K

Релевантность ответа? "Релевантность — это соответствие найденной информации цели поиска".

0

08.11.2023

Юра

К фактологической точности ваша ситуация не имеет никакого отношения. Это просто неверный ответ на вопрос. Ошибка интерпретации запроса. Выдача ложного ответа на входящий запрос.

0

08.11.2023

Nina Sharova

Еще есть замечательное слово «пертинентность» - соответствие результатов поиска информационной потребности потребителя

0

08.11.2023

Arina Ballerina

Nina Sharova
Еще есть замечательное слово «пертинентность» - со...

Размышляю, а вот если топикстартер назовёт раздел «пертинентность документации», будет ли этот заголовок пертинентным (для читателя). Учитывая что скорее всего речь идёт о каком-то отчёте о ревью документации. Но слово и правда замечательное, я о нём раньше не слышала.

0

08.11.2023

Alec

Arina Ballerina
Размышляю, а вот если топикстартер назовёт раздел ...

Пертинентный, персистентный, и консистентный - я бы убрал из текста.

0

08.11.2023

Arina Ballerina

Alec
Пертинентный, персистентный, и консистентный - я б...

консистентность вроде на слуху, в профессиональном сообществе точно

0

08.11.2023

Alec

Мне, англоязычному, все эти слова знакомы и привычны, но для русскоязычной аудитории я бы написал что-нибудь про единообразие.

0

08.11.2023

Arina Ballerina

Alec
Мне, англоязычному, все эти слова знакомы и привыч...

скорее про согласованность, нет? я говорю «консистентный список», когда хочу сказать, что пункты согласованы между собой и внутри пунктов противоречий нет. единообразный или тем более согласованный список — не так поймут, долго объяснять

0

08.11.2023

Alec

Arina Ballerina
скорее про согласованность, нет? я говорю «консист...

Непротиворечивый?

0

08.11.2023

Bogdan Larson

Alec
Пертинентный, персистентный, и консистентный - я б...

чем консистентного заменить?

0

08.11.2023