РЭ: уточнить названия плат

[alx]

В РЭ аппаратуры MC04-DSL-3U редакции 35 на странице 132 есть такой текст:

Порядок подключения платы RP-ххх к плате...

Прочитав его, читатель ошибочно предположит, что есть такая плата "RP-xxx". На самом деле такой платы нет, а есть платы RP-01, RP-400 и RP-650.

Предлагаю для исключения возможности неверного понимания текста заменить в нем "RP-xxx" на "RP-400, RP-650".

По той же причине на странице 134 предлагаю заменить "SM-xx" на "SM-01, SM-02", заменить "RP-xx" на "RP-400, RP-650".

На странице 135 предлагаю заменить "FP-xx" на "FP-01, FP-02", заменить "SM-xx" на "SM-01, SM-02", заменить "RP-xx" на "RP-650".

На странице 136 предлагаю заменить "PS-220x" на "PS-220, PS-220D, PS-220-BRS", заменить "PS-650x" на "PS-650DT".

На странице 137 предлагаю заменить "PS-220xx" на "PS-220, PS-220D, PS-220-BRS", заменить "PS-650x" на "PS-650DT", заменить "FP-xx" на "FP-01, FP-02", заменить "SM-xx" на "SM-01, SM-02", заменить "PS-xx" на "PS-001, PS-24D, PS-48, PS-48D, PS-220, PS-220D, PS-220-BRS, PS-650DT".

На странице 138 предлагаю заменить "PS-220xx" и "PS-220x" на "PS-220, PS-220D, PS-220-BRS", заменить "PS-650x" на "PS-650DT".

[Vladimir]

В РЭ-36 на странице 132 исключил абзац
"Порядок подключения платы RP-ххх к плате..."
т.к. на стр 134 есть отдельный пункт:
"5.23.2 Подключение ДП к платам SМ-01/-02/-03/-04/-11/-12"

Несуществующие платы АЕН и МВН хотят оставить, т.к.информация об этих платах
имеется на нашем сайте, каталоге, прайсе, есть РКД на железо,
поэтому в случае заказа проектной организацией этих плат, софт будет разработан.

Заменил "RP-xx" на "RP-400, RP-650", "FP-xx" на "FP-01, FP-02", "PS-650x" на "PS-650DT"

PS–220х менять не стал, т.к. было разработано, выпущено и находится в эксплуатации
много разновидностей подобных частое повторение всего списка засоряет текст,
а сокращать номенклатуру пока не разрешают
(например, были выпущены и эксплуатируются PS-220-BRS, но их уже никогда не будет,
а текст PS–220х относится и к снятым с производства платам этого типа)

[alx]

Replying to Vladimir:

PS–220х менять не стал, т.к. было разработано, выпущено и находится в эксплуатации
много разновидностей

Если быть точным, то три.

подобных частое повторение всего списка засоряет текст,

??? Непонятно, что подразумевается под словом "засоряет". А упоминание несуществующей платы "PS-220x" текст не засоряет?

а сокращать номенклатуру пока не разрешают

А это и не поможет, ведь даже если какую-то плату сняли с производства, уже произведенные платы от этого эксплуатировать не перестали...

[Vladimir]

У меня на памяти:
PS-220/220D/220DS/220-BRS/220D-12/220D-48/220DT/220DT-48,
возможно, что и ещё чего-нибудь было, или будет.
А если ещё для каждой разновидности записывать полное название с буквами PS,
то строка перечисления будет ещё более длинная, а перечислять потребуется по тексту
несколько раз.

А вот PS-220х (икс) относится ко всем прошлым, настоящим и будущим разновидностям.

"Засоряет" - это когда от полного и бесполезного перечня рябит в глазах :-)

Предложи более краткое обозначение "серии" плат PS-220...

[alx]

Replying to Vladimir:

У меня на памяти:
PS-220/220D/220DS/220-BRS/220D-12/220D-48/220DT/220DT-48,

Ложная память. :)

Платы PS-220DS, PS-220D-12, PS-220D-48, PS-220DT и PS-220DT-48 аппаратурой MC04-DSL-3U не поддерживаются и никогда не поддерживались. Возможно, платы с такими названиями были/есть в какой-то другой аппаратуре (MC04-PLC?), но в MC04-3U таких не было.

возможно, что и ещё чего-нибудь было, или будет.

Повторяю, никогда таких плат не было. Насчет же будущего - в будущем можеть быть разработано все что угодно. Когда и если появится в MC04-DSL-3U какая-то новая плата - тогда и добавим ее в руквоодство...

А если ещё для каждой разновидности записывать полное название с буквами PS,
то строка перечисления будет ещё более длинная,

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

Вот, например, такой текст:

Для настройки платы _ _ _ _ _ _ установите соединение с блоком в браузере и авторизуйтесь (см. пункт 6.1.2) - откроется Web-интерфейс на вкладке Платы (Рис. 6.4). Установите курсор мыши на соответствующую ячейку колонки Тип платы в таблице на вкладке Платы и нажмите левую кнопку компьютерной мышки.

ты повторяешь в разделе каждой платы - и ничего, хотя описанные действия от типа платы не зависят, могли бы быть описаны один раз, и никакой неоднозначности у читателя не возникло бы. А перечислить три названия платы - строка длинная, и пусть лучше читатель гадает, "PS-220x" - это такое название платы, или что-то иное автор подразумевал под этими буквами...

а перечислять потребуется по тексту несколько раз.

Боишься устать? :)

А вот PS-220х (икс) относится ко всем прошлым, настоящим и будущим разновидностям.

А вот тут протестую. Даже если у тебя на рабочем месте есть хрустальный шар, я не верю, что ты можешь видить будущее. И неизвестно, будет ли справедливо то, что сейчас написано для PS-220x, для платы, которую кто-нибудь когда-нибудь разработает в неопределенном будущем, и которой дадут название, тоже начинающееся с "PS-220"...

"Засоряет" - это когда от полного и бесполезного перечня рябит в глазах :-)

Если он бесполезный - просто исключи его из текста, и все. Я же вижу, что, как минимум, в некоторых местах это небесполезно. Например, на странице 12 написано:

при дистанционном питании блока от тракта SHDSL платы PS-220x, PS-650x должны устанавливаться на соседние места с соответствующей платой SM-xx

Пользователь это прочитал, посмотрел - ни одной из перечисленных плат (PS-220x, PS-650x, SM-xx) у него в аппаратеру нет, а есть только SW-01, PS-220D, GE-12, PS-650DT, SM-02... Ну и поставил PS-650DT не рядом с SM-02, ведь РЭ не требовало ставить эти платы рядом!

Я уже не говорю о таких очевидных ситуациях, когда человек ищет в докумнете название своей платы "PS-220D" и находит меньше половины непосредственно касающихся ее мест, так как в большинестве мест написано "PS-220x" вместо "PS-220D"... У PDF-читалок, как правило, нет искусстветнного интелллекта чтобы сообразить, что встречающаяся в тексте строка "PS-220x" - это наверное, как раз то, что нужно пользователю, заказавшему поиск строки "PS-220D"...

Предложи более краткое обозначение "серии" плат PS-220...

Мое предложение - не вводить новые сущности (в данном случае "серия") без необходимости, а перечислить названия плат. Собственно, это предложение написано в описании тикета.

Если же все-таки непременно хочется плодить сущности, сначала надо дать новому понятию определение, а только потом его использовать. Например, если хочется оперировать понятием "серия плат", то назови ее хоть горшком, но дай четкое определение:

"горшок":

серия плат, включающая в себя платы PS-220, PS-220D и PS-220-BRS.

а уже потом используй это понятие в тексте:

Входное напряжение для плат серии "горшок" - от 120 до 385 В.

По-моему так...

[Vladimir]

У тебя железная логика, постараюсь исправить РЭ,
как только появится возможность.

Только вот не знаю, как быть с якобы "несуществующими" платами,
которые в чертежах РКД и в железе, и в проектах, и в прайсах, и в каталогах,
и на сайте есть, и оба руководителя хотят их видеть в РЭ,
несмотря на то, что в софте их пока нет.

Можно ли не выполнить пожелание работодателя?

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

[alx]

Replying to Vladimir:

Можно ли не выполнить пожелание работодателя?

Любое пожелание можно не выполнить, на то оно и "пожелание", а не "приказ". :)

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

[Vladimir]

В тестовом РЭ-42-5 от 25.04.2020 (лежит в ЛидерТаске)
заменил в тексте все иксы в названиях.

[san]

Milestone deleted