Неточность в РЭ: установить соединение с блоком

[alx]

В РЭ аппаратуры MC04-DSL-3U редакции 33 на странице 29 написано: "Для настройки платы SM-xx, установите соединение с блоком в браузере и авторизуйтесь...".

Такая же фраза содержится в разделах описаний всех других плат, а также в разделе 6.1.2.

Это указание неточное, так как соединение устанавливается не с блоком ("корзиной"), а с установленной в блок платой. В блок может быть установлено много разных плат (включая несколько плат SW-01), и с какой конкретно платой необходимо установить соединение, из процитированной фразы неясно. Кроме этого, при открытии браузером веб-интерфейса не обязательно требуется выполнять аутентификацию (не авторизацию! Авторизация выполняется сервером при каждом обращении браузера). Результат аутентификации сохраняется в куках браузера, и если пользователь уже был аутентифицирован, повторно аутентифицироваться ему уже не требуется (если только со времени последнего обращения к аппаратуре не прошло более суток или он закрывал свой браузер). К тому же в процитированном тексте присутствует лишняя запятая.

Предлагаю переформулировать процитированный текст примерно следующим образом:

Для настройки платы SM-01 или SM-02 введите в адресной строке веб-браузера адрес платы SW-01 (при наличии в блоке основной и резервной плат SW-01 введите адрес той платы, которая в данный момент работает в активном режиме). В случае появления диалога "Аутентификация" введите логин и пароль, выберите желаемый тип веб-интерфейса ("Мультиплексор" или "IP-АТС") и нажмите "Войти".

Неплохо было бы сопроводить это соответствующей картинкой.

С другой стороны, мне не кажется оправданным повторять этот текст в разделе описания каждой платы. В этой связи второе предложение: так как диалог конфигурации всех плат в веб-интерфейсе открывается единообразно, предлагаю описать этот процесс один раз где-нибудь в разделе "Конфигурирование аппаратуры", а из разделов описания каждой конкретной платы - убрать, начав раздел вводной фразой типа: Диалог настройки плат SM-01, SM-02 в веб-интерфейсе состоит из двух вкладок - "Состояние" и "Конфигурация"...

То же самое касается всех остальных плат.

[alx]

Дополню второе предложение. Первый раз читатель сталкивается с использованием веб-интерфейса на странице 22, где описано получение информации о модуле SFP. Второй раз - при описании настройки шлюза MC04-TDMoIP.SFP. Это все находится на вкладке "Ethernet", которая в веб-интерфейсе третья по счету. Сразу у читателя возникает недоумение: почему начали рассказ с третьей вкладки, а для чего перавая и вторая? :)

Далее, в описании плат SM-01 и SM-02 говорится об их настройках. Настройки - это опять вторая вкладка в окне диалога конфигурации. А первую - пропустили...

Еще далее, в описании настроек, например, говорится (таблица 2.9 на странице 30): "Блокировка - Установка галочки отключает работу интерфейса. светодиод на лицевой панели платы не горит". Это не совсем так: для того чтобы интерфейс заблокировался, недостаточно просто установить галочку, надо после этого еще и записать конфигурацию в плату. Более того, для платы SM-01 и этого недостаточно, надо выполнить рестарт платы чтобы записанная конфигурация вступила в силу. У читателя же на момент прочтения сложится неверное представление о том, что установка чекбокса начинает действовать немедленно: установил отметку - и светодиод погас, интерфейс выключился...

Предлагаю излагать информацию о конфигурации более последовательно, от общего к частному. Например, где-то в общей части написать, что есть веб-интерфейс, и как в него войти (аутентифицироваться). Рассказать (не вдаваясь в детали), из каких основных элементов он состоит (например перечислить вкладки верхнего уровня, и за что каждая из них отвечает). Далее рассказать, что на вкладке "Платы" есть таблица плат, и что для (почти) каждой платы там можно открыть диалог (тут не помешает описать общие свойства диалогов, например что их можно перемещать за заголовок и закрывать клавишей ESC). Затем уже можно описывать диалоги конфигурации конкретных типов плат, но тоже от общего к частному: что у плат SM-01 и SM-02 диалог делится на вкладки "Состояние" и "Конфигурация", что конфигурация записывается в плату кнопками "OK" или "Применить", и что вступает в действие после рестарта платы, и только после этого описывать каждый из элементов конфигурации...

[Vladimir]

1. Блок МС04-DSL-3U и "корзина" (кассета, крейт, каркас и т.п.) - это 2 большие разницы.

"Корзина" в Каталоге, в Прайсе, в РЭ, в сборочных чертежах РКД называется "Кассета",
а вот Блок содержит Кассету и хотя бы 2 платы: SW-01 и, например, PS-48,
т.е. без этих плат это уже не блок МС04-DSL-3U (см.п.2.3.1 в РЭ-35).
Поэтому фраза "установите соединение с блоком в браузере"
подразумевает соединение с SW-01, а как именно это сделать сказано в продолжении
этого предложения: "...и авторизуйтесь (см. пункт 6.1.2) - откроется Web-интерфейс на вкладке Платы (Рис. 6.4)......"
С тем, что надо переформулировать согласен, сделаю и согласую.

2. К вопросу о шлюзе SFP - его можно вставить только в плату SW-01,

поэтому он и попал в главу описания SW-01, а эта плата видит этот шлюз,
как интерфейс SFP-Ethernet, к тому же это не плата, поэтому первые вкладки
"Плата" и "Журнал" к шлюзу не очень подходят.

3. Относительно повторения текста.

Когда я только начал редактировать, то возник большой спор между двумя директорами:

АЕН хотел разбить РЭ на множество небольших, т.е. пости отдельно для каждой платы,
ну или для каждой родственной группы плат.

МВН хотел единое РЭ на все платы и блоки.

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

АЕН не нравится, когда много ссылок из одного конца огромного РЭ в другой...

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

[alx]

Replying to Vladimir:

фраза "установите соединение с блоком в браузере" подразумевает соединение с SW-01,

Я-то прекрасно понял, что подразумевалось. :) А вот читатель, который первый раз в жизни видит наше оборудование, прочитав этот текст, не сможет догадаться, что здесь подразумевается именно это, а не что-то совсем другое...

2. К вопросу о шлюзе SFP - его можно вставить только в плату SW-01,

Это почему это? Его можно вставить в любой порт ethernet с соответствующей розеткой. Например в коммутатор, который у нас в серверной раздает всем ethernet...

поэтому он и попал в главу описания SW-01, а эта плата видит этот шлюз,

По этой же логике настройки любой платы, например FS-08, тоже должны попадать в главу описания SW-01, ведь это SW-01 видит FS-08 (как и все остальные платы) и формирует/записывает в них конфигурацию... :)

к тому же это не плата, поэтому первые вкладки "Плата" и "Журнал" к шлюзу не очень подходят.

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