![[MC-04 logo]](/mc-04/chrome/site/logo.png){kind=logo}
#577 closed улучшение (готово)
РЭ: ненужная информация в описании плат VE-01/VE-02
| Reported by: | alx | Owned by: | Vladimir |
|---|---|---|---|
| Priority: | minor | Component: | Руководство по эксплуатации |
| Keywords: | Cc: |
Description
В РЭ аппаратуры MC04-DSL-3U редакции 40 в разделе 7.2 на странице 203 написано:
При изменении IP-настроек платы необходимо перезагрузить плату, нажав кнопку Рестарт. Начиная с 20-ой ревизии прошивки платы, рестарт делать нет необходимости.
Мне кажется, что если в современных ревизиях выполнять рестарт нет необходимости, то и нет необходимости писать в РЭ о том, что когда-то такая необходимость была. Предлагаю исключить процитированный текст из РЭ.
Change History (22)
follow-up: 4 comment:1 by , 5 years ago
comment:2 by , 5 years ago
А если у кого-то до сих пор установлена и работает одна из предыдущих 19 прошивок?
Нужно срочно посоветовать ему обновиться до актуальной ревизии. Если вы знаете такого пользователя, подскажите ему.
follow-up: 5 comment:3 by , 5 years ago
Дело в том, что АДС не может точно знать обо всех сотнях юзеров текущее состояние их МС04 и ПО
- вот поэтому в новых РЭ полезно напомнить всем юзерам, что
"Начиная с 20-ой ревизии прошивки платы, рестарт делать нет необходимости".
Я предполагаю, что 99,9% всех юзероав не помнят наизусть номер текущей версии ПО.
Кстати: а если кто-то в 20-й и далее версии нажмёт кнопку Рестарт,
то что случится - МС04 взорвётся, или слетят все настройки всего ПО ? :-)
comment:4 by , 5 years ago
Replying to Vladimir:
А если у кого-то до сих пор установлена и работает одна из предыдущих 19 прошивок?
Не понял вопрос. Что "а если"? Что в этом случае делать? Обновить прошивку.
РЭ на сайте могут читать и юзеры всех прошивок, а у кого-то по старой памяти сохранилась в голове информация о необходимости перезагрузки, то после прочтения этой фразы он, возможно, запомнит, что теперь перезагрузку делать не надо. Разве это плохо?
Это очень хорошо! Но надо быть последовательным, и следовать этому принципу во всем, а не только в описании настроек IP!
Например, начиная с r1725 изменился порядок установки плат в кассету при использовании варианта веб-интерфейса "IP-АТС": ранее требовалось устанавливать плату VE-01 в слот 1, а начиная с r1725 ее надо устанавливать в слот 10. В текст РЭ было внесено соответствующее изменение. Но сохранилось ли в РЭ указание на то, что при использовании пакета sw ревизии ниже r1725 плату VE-01 надо устанавливать в слот 1? По-моему, нет. Как же так? Откроет пользователь, до сих пор использующий пакет sw ревизии ниже r1725 РЭ, прочитает его, установит VE-01 в слот 10 - и будет у него что-нибудь работать неправильно!
Или другой пример. Начиная с sw:r1489 в web-интерфейсе было изменено добавление/редактирование SIP-пользователей. В РЭ было внесено соответствующее изменение. Но было ли сохранено в РЭ описание добавления SIP-пользователя, как оно было до r1489? По-моему, нет. А как же так? Захочет пользователь, до сих пор использующий пакет sw более старой ревизии, чем r1489, добавить SIP-пользователя, откроет РЭ редакции 40 - а там не написано, как это сделать для его ревизии пакета!
Будь последователен, и описывай тогда все особенности всех более ранних ревизий всех пакетов! Правда размер РЭ станет в несколько раз больше, но зато им сможет руководствоваться пользователь с любой ревизией любого пакета...
comment:5 by , 5 years ago
Replying to Vladimir:
Кстати: а если кто-то в 20-й и далее версии нажмёт кнопку Рестарт,
то что случится - МС04 взорвётся, или слетят все настройки всего ПО ? :-)
Что случится при нажатии кнопки "Рестарт", должно быть написано в Руководстве по эксплуатации. Разве не написано? :) Надо написать. Будет выполнен рестарт платы. :)
follow-up: 10 comment:6 by , 5 years ago
На Рис. 7.9 Вкладка Настройки платы VE-01
есть кнопка "Рестарт" и есть единственное упоминание про эту кнопку для платы VE-01 - это в той фразе, которую ты предлагаешь удалить на стр.203.
Остальные упоминания про Рестарт только на стр.16(SW), 32(SM), 49(TE-01) и 51(ТЕ-04).
Прочитав 203 страницы текста вряд ли кто вспомнит про описание кнопки Рестарт,
поэтому первую строчку твоей цитаты надо бы оставить
(При изменении IP-настроек платы необходимо перезагрузить плату, нажав кнопку Рестарт.)
а вторую строчку про 20-ю ревизию можно и убрать,
("Начиная с 20-ой ревизии прошивки платы, рестарт делать нет необходимости."),
хотя я бы оставил (не вижу вреда от нажатия на Рестарт,
а вот польза для забывчивых напомнить об этом удобстве есть),
но Разработчикам-Авторам плат и ПО виднее :-)
Если Саша согласен убрать, то уберу, мне не жалко.
follow-up: 11 comment:7 by , 5 years ago
А м.б. в РЭ рисунок окна настройки VE устаревший,
тогда пришлите новый рисунок без кнопки Рестарт.
comment:8 by , 5 years ago
Если Саша согласен убрать, то уберу, мне не жалко.
Нужно убрать устаревшую информацию из РЭ:
При изменении IP-настроек платы необходимо перезагрузить плату, нажав кнопку Рестарт. Начиная с 20-ой ревизии прошивки платы, рестарт делать нет необходимости.
follow-up: 12 comment:9 by , 5 years ago
В РЭ-41 удалил,
но тогда зачем кнопка Рестарт в окне настроек VE,
если её назначение не надо описывать?
Будут же лишние вопросы от излишне любопытных юзеров...
comment:10 by , 5 years ago
Replying to Vladimir:
Прочитав 203 страницы текста вряд ли кто вспомнит про описание кнопки Рестарт,
поэтому первую строчку твоей цитаты надо бы оставить
(При изменении IP-настроек платы необходимо перезагрузить плату, нажав кнопку Рестарт.)
Хм... Это утверждение мне кажется странным и удивительным сразу по двум причинам.
Во-первых, я не вижу в нем логики: каким образом из трудности вспоминания описания кнопки Рестарт (которого, как выясняется, нет) следует необходимость оставить первую строчку процитированного текста? По-моему, никак.
Во-вторых, первая строчка цитаты не соответствует действительности. Желание оставить в тексте РЭ несоответствующее действительности утверждения я нахожу, мягко говоря, странным...
comment:11 by , 5 years ago
Replying to Vladimir:
А м.б. в РЭ рисунок окна настройки VE устаревший,
Да, в РЭ редакции 40 рисунок 7.9 устаревший.
тогда пришлите новый рисунок без кнопки Рестарт.
??? Непонятно, зачем присылать рисунок без кнопки "Рестарт", если в действительности кнопка "Рестарт" есть...
comment:12 by , 5 years ago
Replying to Vladimir:
но тогда зачем кнопка Рестарт в окне настроек VE,
если её назначение не надо описывать?
К кому вопрос? Кто сказал, что кнопку "Рестарт" не надо описывать? Я, например, в comment:5 наоборот, говорил, что надо...
Будут же лишние вопросы от излишне любопытных юзеров...
Это разумное возражение стоит адресовать тому, кто говорил, что эту кнопку не надо описывать.
follow-up: 14 comment:13 by , 5 years ago
Если рисунок 7.9 устаревший, то пришли новейший рисунок и я заменю устаревший,
но если и в новейшем есть Рестарт, то что про него правильно написать:
для чего нужен рестарт для платы VE - в каких случаях нажимать эту кнопку?
(я эту кнопку для VE ни разу в жизни не нажимал :-) ).
Напиши кратко то, что считаешь нужным и правильным для РЭ про Рестарт в окне VE.
comment:14 by , 5 years ago
Replying to Vladimir:
Если рисунок 7.9 устаревший, то пришли новейший рисунок и я заменю устаревший,
Новейший рисунок приложен к тикету #480:
Напиши кратко то, что считаешь нужным и правильным для РЭ про Рестарт в окне VE.
Кратко я это уже написал в comment:5. :) Но если более развернуто, то:
Кнопка "Рестарт" производит полную перезагрузку платы.
В каких случаях ее следует нажимать, я затрудняюсь сказать. По идее, необходимости в ней быть не должно, но убирать ее я не хочу - пусть останется на случай, если по какой-то причине пользователю все-таки потребуется выполнить рестарт платы.
follow-up: 16 comment:15 by , 5 years ago
Спасибо, но в РЭ для этого пункта и рисунка окна VE ещё нет слов про кнопку "Журналирование"
и про "Ключи SSH". Про журналирование могу сослаться на пункт:
"6.2.22 Вкладка CDR – журналирование выполняемых вызовов"
Это будет уместно в п.7.2 настройки VE ?
Или лучше привести одну строчку с определением этого понятия
(если лучше кратко описать, то предложи вариант).
Поиск по сочетанию "SSH" дал три упоминания: на стр.48 про SW-01,
но описания или хотя бы расшифровки этих букв нет,
есть только упоминание про некий неизвестный "сервер SSH" и "SSH-клиент".
Хорошо бы это тоже уточнить в РЭ хотя бы кратко...
Расшифровку сочетания SSL в РЭ я тоже не нашёл
(встречается 4 раза как "Сертификат SSL").
Хотелось бы при чтении РЭ обходиться без Гугла и Яндекса...
comment:16 by , 5 years ago
Replying to Vladimir:
Спасибо, но в РЭ для этого пункта и рисунка окна VE ещё нет слов про кнопку "Журналирование"
и про "Ключи SSH". Про журналирование могу сослаться на пункт:
"6.2.22 Вкладка CDR – журналирование выполняемых вызовов"
Это будет уместно в п.7.2 настройки VE ?
Пожалуй, нет. Не вижу необходимости в такой ссылке.
Или лучше привести одну строчку с определением этого понятия
(если лучше кратко описать, то предложи вариант).
Что-то я запутался... Этот тикет я создал чтобы предложить убрать бессмысленное и, на мой взгляд, странное упоминание о том, что в каких-то из давно устаревших ревизиях прошивки платы после изменения настроек IP надо было выполнять рестарт платы. Какое отношение ссылка на раздел CDR, о которой ты пишешь, имеет к моему предложению? Вариант чего ты от меня хочешь? Мне казалось, вариантов может быть только два:
- Ты принимаешь мое предложение и удаляешь процитированный в описании тикета текст из РЭ.
- Ты отклоняешь мое предложение, и ничего не делаешь.
При чем тут CDR и SSH?
follow-up: 18 comment:17 by , 5 years ago
Твоё предложение принимаю и уже удалил из РЭ-41 твою цитату,
но увидел в твоём обновлённом рисунке кнопку "Журналирование"
и подумал, что уж заодно в этом же пункте дать описание этой кнопки.
Если описание не требуется, то его и не будет.
Одновременно с кнопкой "Журналирование" я обратил внимание,
что в этом же окне на Рис.7.9 присутствует кнопка "Ключи SSH",
на которую тоже нет никакого описания, а SSH вообще нигде в РЭ
не расшифровано - так уж заодно надо и его расшифровать для ясности,
это же всё в одном и том же пункте на одной и той же странице.
В некоторых случаях ты требуешь описание всех без исключения кнопок,
включая, например, кнопку "ОК", а тут тоже есть не описанные кнопки и понятия
и на мой взгляд их надо бы как-то расшифровать...
Я, например, сей момент не помню, что такое SSH (как и SSL)
и думаю, что я не один такой, даже в АДС :-)
Если ты и Саша скажете, что про SSH (как и SSL) юзерам и не надо знать,
и описание кнопки "Ключи SSH" не требуется, то не буду это добавлять и закрою тикет.
comment:18 by , 5 years ago
Replying to Vladimir:
Твоё предложение принимаю и уже удалил из РЭ-41 твою цитату,
но увидел в твоём обновлённом рисунке кнопку "Журналирование"
и подумал, что уж заодно в этом же пункте дать описание этой кнопки.
Это все, конечно, чрезвычайно интересно и замечательно! Странно только, что ты об этом почему-то пишешь в комментариях к тикету, написанному на совершенно другую тему, а не в уже упомянутом выше тикете #480, в котором как раз и было предложено добавить описание кнопки "Журналирование"...
follow-up: 20 comment:19 by , 5 years ago
Тикет 480 был 4 месяца назад, меня отвлекли на другие
скоропостижные и неспихуемые дела, поэтому 480 ушёл на задний план,
спасибо, что напомнил - постараюсь закрыть и 480.
А про описание SSH (как и SSL), в частности про кнопку "Ключи SSH) был тикет?
Если нет, то можешь ли кратко описать?
comment:20 by , 5 years ago
Replying to Vladimir:
А про описание SSH (как и SSL), в частности про кнопку "Ключи SSH) был тикет?
В trac есть функция поиска, с помощью которой можно найти тикеты, в которых упоминаются нужные слова. Да, по SSH есть тикет: #163.
И еще, ты, наверняка, это и так это знаешь, но на всякий случай напомню, что посмотреть в проекте mc-04 trac все открытые тикеты, владельцем которых ты являешься, можно в разделе просмотр карточек --> Мои тикеты.
comment:21 by , 5 years ago
| Resolution: | → готово |
|---|---|
| Status: | new → closed |
А если у кого-то до сих пор установлена и работает одна из предыдущих 19 прошивок?
РЭ на сайте могут читать и юзеры всех прошивок, а у кого-то по старой памяти сохранилась в голове информация о необходимости перезагрузки, то после прочтения этой фразы он, возможно, запомнит, что теперь перезагрузку делать не надо. Разве это плохо?