Opened 3 years ago

Closed 3 years ago

Last modified 23 months ago

#898 closed улучшение (готово)

РЭ: уточнить, режим чего именно имеется в виду

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

Description

В РЭ аппаратуры MC04-DSL-3U редакции 51 в п. 5.8.2 на странице 66 есть такая фраза:

В режиме IP-АТС плата VE-01 устанавливается только на место 10 (резервирование SW-01 в этом случае не поддерживается).

В этой фразе не уточняется, режим чего имеется в виду. Как оказалось, эту фразу можно ошибочно понять как свидетельство наличия такого режима у аппаратуры MC04-DSL-3U. На самом же деле здесь имеется в виду режим не самой аппаратуры, а вариант отображения web-интерфейса.

Кроме этого, в данном разделе первый раз упоминается вариант web-интерфейса, поэтому было бы хорошо добавить небольшую вводную часть, в которой сообщить читателю о том, что web-интерфейс аппаратуры имеет два разных варианта - "Мультиплексор" и "IP-АТС".

Для исключения возможности подобного недопонимания предлагаю дополнить данную фразу уточнением, что имеется в виду именно web-интерфейс, например так:

Web-интерфейс аппаратуры имеет два варианта:"Мультиплексор" и "IP-АТС". Вариант "Мультиплексор" обеспечивает оператору полный контроль над организацией (коммутацией) каналов в блоке MC04-DSL-3U. Вариант "IP-АТС" - упрощенный интерфейс, ориентированный на работу с платой VE-01, в котором коммутация телефонных каналов выполняется автоматически. В случае, если планируется использовать вариант web-интерфейса "IP-АТС", плата VE-01 должна устанавливаться на место 10 (резервирование SW-01 в этом случае не поддерживается). Вариант web-интерфейса "Мультиплексор" не накладывает дополнительных ограничений на место установки платы.

Также прошу обратить внимание, что в диалоге аутентификации, где выбирается вариант "IP-АТС" или "Мультиплексор", это называется не "режимом", а "вариантом". Для исключения возможной путаницы было бы разумно везде использовать именно это слово, а не синонимы "тип", "режим" и т.п.

Change History (7)

in reply to:  description ; comment:1 by Vladimir, 3 years ago

Replying to alx:

... имеется в виду ... вариант отображения web-интерфейса.

Теперь стало понятнее.

Кроме этого, в данном разделе первый раз упоминается вариант web-интерфейса, поэтому было бы хорошо добавить небольшую вводную часть, в которой сообщить читателю о том, что web-интерфейс аппаратуры имеет два разных варианта - "Мультиплексор" и "IP-АТС".

Для Веб-интерфейса есть большой и подробный раздел, поэтому эти варианты, на мой взгляд, лучше пояснить, как описание элементов окна п.6.1.2, например, над "Рис. 6.3 Окно аутентификации соединения с блоком в web-браузере":
"...и нажмите Войти. Вариант Мультиплексор обеспечивает оператору полный контроль над организацией (коммутацией) каналов в блоке
MC04-DSL-3U. Вариант IP-АТС – упрощенный интерфейс, ориентированный на работу с платой VE-01, в котором коммутация телефонных каналов выполняется автоматически (вариант IP-АТС предназначен для конфигурации в качестве голосового шлюза с функцией IP-АТС, см. Руководство по эксплуатации КВ3.090.027 РЭ)."

Для исключения возможности подобного недопонимания предлагаю дополнить данную фразу уточнением, что имеется в виду именно web-интерфейс, например так:

... В случае, если планируется использовать вариант web-интерфейса "IP-АТС", плата VE-01 должна устанавливаться на место 10 (резервирование SW-01 в этом случае не поддерживается). Вариант web-интерфейса "Мультиплексор" не накладывает дополнительных ограничений на место установки платы.

А вот для места установки плат есть отдельный пункт про железо:
"5.8.2 Конструкция и порядок установки платы VE-01 в блоке"
и тут будет к месту:
"При выборе варианта web-интерфейса IP-АТС (см. п.6.1.2, Рис. 6.3) плата VE-01 устанавливается только на место 10 (резервирование SW-01 в этом случае не поддерживается).
Вариант web-интерфейса Мультиплексор не накладывает дополнительных ограничений на место установки платы. Руководство по настройке платы VE-01 и её применению в качестве голосового шлюза, а также как IP-АТС, размещено в пункте 7."

Есть ли у тебя замечания по такому распределению твоего текста по двум пунктам РЭ?
(а также как IP-АТС в тексте рол Руководство тебя не смущает?)

Для исключения возможной путаницы было бы разумно везде использовать именно это слово, а не синонимы "тип", "режим" и т.п.

Согласен, а если забуду, то ты напомни, чтобы не забыть исправить!

in reply to:  1 ; comment:2 by alx, 3 years ago

Replying to Vladimir:

Есть ли у тебя замечания по такому распределению твоего текста по двум пунктам РЭ?

Есть. По моему мнению, такое изложение материала непоследовательно, так как сначала в п. 5.8.2 упоминается один из вариантов web-интерфейса, а только потом в п. 6.2.1 читателю сообщают о том, что у web-интерфейса есть два варианта...

(а также как IP-АТС в тексте рол Руководство тебя не смущает?)

Смущает.

Согласен, а если забуду, то ты напомни, чтобы не забыть исправить!

Не стал ждать, когда ты забудешь. :) Напомнил, создав тикет #900.

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

Replying to alx:

Replying to Vladimir:

Есть ли у тебя замечания по такому распределению твоего текста по двум пунктам РЭ?

Есть. По моему мнению, такое изложение материала непоследовательно, так как сначала в п. 5.8.2 упоминается один из вариантов web-интерфейса, а только потом в п. 6.2.1 читателю сообщают о том, что у web-интерфейса есть два варианта...

Вот, хорошо, что я разместил свой вариант неполноценного текста тут
и получил от тебя важные и ценные замечания.

У нас же во всём РЭ исторически сложилось так, что сначала описывается железо,
включая его настройку, например, "5.7.3 Настройка платы TE-04" - это для всех плат модулей и субмодулей. Исключение сделано только для плат VE:
"7 УПРАВЛЕНИЕ ГОЛОСОВЫМ ШЛЮЗОМ VE: платы VE-01, VE-02" - т.к. этот пункт гигантский:
занимает порядка половины страниц РЭ.
И для огромного п."6 СИСТЕМА УПРАВЛЕНИЯ БЛОКА MC04−DSL-3U" сделан отдельный пункт сразу после описания железа, в котором есть, конечно, ссылки на этот огромный п.6.
В первую очередь потребителю требуется информация по железу: конструкция, параметры, как подключить (вплоть до номеров контактов), а уж после установки плат и подключения уже потребуется Система управления, а для некоторых и информация по управлению платами VE
(у многих плат VE нет и, возможно, никогда не будет).

Текст п."5.8.2 Конструкция и порядок установки платы VE-01 в блоке"
Я изменил, как мне кажется в лучшую сторону:

"При выборе варианта web-интерфейса Мультиплексор (см. п.6.1.2, Рис.6.3) нет дополнительных ограничений на место установки платы VE-01.
При выборе варианта web-интерфейса IP-АТС плата VE-01 устанавливается только
на место 10 (резервирование SW-01 в этом случае не поддерживается).
Руководство по настройке платы VE-01 и её применению в качестве голосового шлюза,
а также при выборе варианта web-интерфейса IP-АТС, размещено в пункте 7."

Из этого текста уже понятно, что есть по крайней мере 2 варианта web-интерфейса
и это подтверждается гиперссылкой на "(см. п.6.1.2, Рис.6.3)" из которых это уже абсолютно ясно видно.

(а также как IP-АТС в тексте рол Руководство тебя не смущает?)

Смущает.

А сразу написать правильно не мог, или "рука не поднимается" :-),
ну, например, так:
"Руководство по настройке платы VE-01 и её применению в качестве голосового шлюза,
а также при выборе варианта web-интерфейса IP-АТС, размещено в пункте 7."
Ещё замечания есть? Я готов исправить всё, что скажет Автор платы VE ;-)

Согласен, а если забуду, то ты напомни, чтобы не забыть исправить!

Не стал ждать, когда ты забудешь. :) Напомнил, создав тикет #900.

Завтра попробую найти все синонимы и заменить на "вариант".

in reply to:  3 ; comment:4 by alx, 3 years ago

Replying to Vladimir:

(а также как IP-АТС в тексте рол Руководство тебя не смущает?)

Смущает.

А сразу написать правильно не мог, или "рука не поднимается" :-),

Не мог.

Ещё замечания есть? Я готов исправить всё, что скажет Автор платы VE ;-)

Другие замечания к тексту РЭ есть в других еще не закрытых тикетах компонента "Руководство по эксплуатации".

in reply to:  4 ; comment:5 by Vladimir, 3 years ago

Resolution: готово
Status: newclosed

Replying to alx:

Replying to Vladimir:

(а также как IP-АТС в тексте рол Руководство тебя не смущает?)

Смущает.

А сразу написать правильно не мог, или "рука не поднимается" :-),

Не мог.

Ещё замечания есть? Я готов исправить всё, что скажет Автор платы VE ;-)

Другие замечания к тексту РЭ есть в других еще не закрытых тикетах компонента "Руководство по эксплуатации".

А между строк-то было же написано: "... по этому тикету № 898",
а ты опять не увидел!
Но, "молчание по Этому тикету - знак согласия!", поэтому
в РЭ-52 от сего дня закрываю этот тикет с текстом в РЭ-52 по комм-3

Last edited 3 years ago by Vladimir (previous) (diff)

in reply to:  5 comment:6 by alx, 3 years ago

Replying to Vladimir:

А между строк-то было же написано: "... по этому тикету № 898",
а ты опять не увидел!

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

comment:7 by san, 23 months ago

milestone: 1 очередь

Milestone deleted

Note: See TracTickets for help on using tickets.