Pull to refresh

К вопросу о документации

Reading time3 min
Views2.5K
Original author: Jack Ganssle
(Примечание переводчика ПП — я надеялся, что проблема только у нас, и если я не вижу каких то параметров в даташите, то либо я просто не умею их читать, либо это неправильные дата и где-то есть настоящие. Но раз об этом пишет Джек, который, я надеюсь, имеет доступ к самым правильным дата, значит, действительно Все Очень Плохо).

Должен ли поставщик гарантировать поставку компонентов, соответствующих описанию? И наоборот, как добиться соответствия описания реальному компоненту?

Недавно я получил несколько писем от инженеров, которые обнаружили, что различные компоненты просто не работают, как должны. Это явление не назовешь новым: я помню, как в 1970-х годах, NEC сделал первый контроллер гибких дисков. Описание нескольких регистров было неправильным. В то время ходила шутка (пример смеха сквозь слезы), что наиболее часто используемые биты следует описывать с инверсией или перемещать. С этой проблемой сталкивались все, кто работал в нашей отрасли более-менее длительно.

В старину компоненты были простыми, а описания — краткими. Нетрудно полностью описать простой компонент. Сегодня даже сшестеренный инвертор 7404 имеет 27-страничное техническое описание!

MCU и SoCs несколько сложнее. Небольшое 8-битное устройство может иметь спецификацию в сотни страниц; для более сложных устройств она может занимать и тысячи. Люди не идеальны, так как можно ожидать совершенства в документации?

Тем не менее, совершенно необходимо, чтобы техническое описание было гарантированным. Если вы использовали компонент, как указано в документации, поставщик обязан обеспечить ее функционирование.

Таблицы данных обычно неправильны. У самих компонентов часто есть недостатки; один корреспондент пожаловался, что в обычном 8-битном MCU одна (из нескольких десятков) инструкций работает неправильно. Поставщик ответил, что «никто больше не использует ассемблер, а компиляторы C не используют данную инструкцию».

Если техническое описание больше не является гарантией функционирования, то зачем оно вообще нужно?

Клиенты, которые обнаруживают ошибки, могут сообщить об этом поставщику, который (мы надеемся) либо исправит компонент/документацию, либо выпустит лист ошибок. Но другая распространенная жалоба заключается в том, что по крайней мере некоторые поставщики никогда не отвечают на запросы о помощи. Сегодня нас часто перенаправляют на форум поддержки, где большая часть «поддержки» осуществляется другими клиентами (ПП — на многих форумах есть представители компании, по крайней мере они так себя обозначают, но их сообщения и ответы все равно официальными не являются). Общение клиентов может вообще компанией не учитываться. Форумы весьма эффективны для поставщика, но часто не удовлетворяют потребности пользователей.

Если я использую 7404, где в дата указано, что max tPLH составляет 22 нс, то я, безусловно, могу ожидать, что компонент, если он будет использоваться правильно, никогда не будет медленнее, чем указанное значение. Разве мы не должны быть так же уверенными в поведении, скажем, таймеров MCU в любом режиме?

Как вы относитесь к происходящему? И мне бы хотелось услышать мнение изготовителей (можно на условиях анонимности).

(ПП типичный мой разговор с разработчиками одной из отечественных фирм «У Вас ошибка в описании на странице ХХХ. — Спасибо, мы знаем.» Они, блин, знают об ошибке вот уже 3 года и ничего не делают, чтобы ее исправить, но нашли время сделать редизайн сайта)

(ПП а вот круто было бы на фоне всеобщего пофигизма вдруг кто-нибудь, и желательно отечественный производитель, внезапно выкатывает на рынок полное, исчерпывающее и абсолютно верное описание на свой компонент и все, в том числе и за рубежом, радостно начинают его применять, остальные производители начинают дико завидовать и вынуждены поднимать качество своей документации).
Only registered users can participate in poll. Log in, please.
Что можно сделать для повышения качества документации
20% Ничего, поезд давно ушел и его не догнать5
8% Единственное правильное решение — шарашки (как вариант — депремирование)2
52% Хорошо отлаженная обратная связь и работа сообщества может постепенно привести к результатам13
20% Невидимая рука рынка все наладит, волноваться не надо5
25 users voted. 20 users abstained.
Tags:
Hubs:
Total votes 6: ↑5 and ↓1+4
Comments4

Articles