Opened 3 years ago

Closed 3 years ago

Last modified 23 months ago

#860 closed дефект (готово)

РЭ: уточнить названия плат (эпизод 5)

Reported by: alx Owned by: Vladimir
Priority: major Component: Руководство по эксплуатации
Keywords: Cc:

Description

В РЭ аппаратуры MC04-DSL-3U редакции 51 во многих местах упоминается несуществующая "плата VE". См. например названия разделов 7, 7.1, 7.1.1, 7.1.4, 7.4 на странице 5. Ранее (в редакции 50) такого не было. Догадываюсь, что на самом деле имеется в виду, что написанное в упомянутых разделах имеет отношение и к плате VE-01, и к плате VE-02.

Считаю такое "нововведение" плохим и вредным, так как, в отличие от нас (сотрудников АДС), пользователи аппаратуры Mc04-DSL-3U не знают, что платы "VE" в аппаратуре MC04-DSL-3U не существует, и, таким образом, не может догадаться, о том, что на самом деле здесь имеется в виду. Неискушенный читатель, прочитав, например, название раздела "Особенности обновления плат VE" подумает, что в аппаратуре действительно имеется плата с наименованием "VE", особенности обновления которой и описаны в данном разделе. А так как у него в хозяйстве плат "VE" нет (есть только VE-01 и VE-02), то и читать раздел об особенностях обновления плат, которых у него нет, человек не станет. :)

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

Учитывая вышесказанное, предлагаю заменить в тексте РЭ упоминание плат "VE" на "VE-01, VE-02" и больше никогда неочевидные для читателей сокращения названий типа VE, VE-xx, VE-* не использовать! Текст от этого не станет сильно длиннее, зато будет устранена возможность недопонимания со стороны читателей.

Change History (4)

comment:1 by alx, 3 years ago

Summary: РЭ: упоминание несуществующей платы "VE"РЭ: уточнить названия плат (эпизод 5)

comment:2 by san, 3 years ago

Насколько я помню, В.А. собирался ввести термин "платы VE", по аналогии как это было сделано c "платами SM"

5.2 Платы SM (SHDSL модем): SМ-01, SМ-02, SМ-03, SМ-04

...К платам SM относятся платы типов SМ-01, SМ-02, SМ-03, SМ-04 (далее в тексте РЭ
упоминание плат SM следует понимать, как относящееся к любой из плат, перечисленных выше
типов).

Но я не вижу в тексте РЭ описания термина "платы VE".

Version 0, edited 3 years ago by san (next)

in reply to:  2 comment:3 by Vladimir, 3 years ago

Resolution: готово
Status: newclosed

Replying to san:

5.2 Платы SM (SHDSL модем): SМ-01, SМ-02, SМ-03, SМ-04
...К платам SM относятся платы типов SМ-01, SМ-02, SМ-03, SМ-04 (далее в тексте РЭ упоминание плат SM следует понимать, как относящееся к любой из плат, перечисленных выше типов).

Но я не вижу в тексте РЭ описания термина "платы VE".

Как я заметил, во всех разделах РЭ, кроме раздела 7, указаны конкретно платы
"VE-01", или "VE-02", или "VE-01, VE-02", или "VE-01 и VE-02"
и только в разделе 7 часто встречается
"платы VE", поэтому в РЭ-52 от 12.11.2021 я добавил пояснение:
"7 УПРАВЛЕНИЕ ГОЛОСОВЫМ ШЛЮЗОМ VE: платы VE-01, VE-02
7.1 Общая информация плат VE-01, VE-02

На платах VE-01 и VE-02 реализованы функции VoIP-шлюза (далее в тексте РЭ упоминание плат VE следует понимать, как относящееся к любой из плат, перечисленных выше типов)."

comment:4 by san, 23 months ago

milestone: 1 очередь

Milestone deleted

Note: See TracTickets for help on using tickets.