![[MC-04 logo]](/mc-04/chrome/site/logo.png){kind=logo}
#601 closed улучшение (готово)
РЭ: подпрограмма платы SW-01
| Reported by: | alx | Owned by: | Vladimir |
|---|---|---|---|
| Priority: | major | Component: | Руководство по эксплуатации |
| Keywords: | Cc: |
Description
В РЭ аппаратуры MC04-DSL-3U редакции 41 в п. 2.6.30 на странице 197 есть такой текст:
При подтверждении произойдет перезагрузка подпрограммы платы SW-01, отвечающей за конфигурацию блока и отображение информации в браузере.
Так как ответа на вопрос, заданный в ticket:547#comment:2, не последовало, я считаю, что аргументов в пользу использованной формулировки нет. Лично мне непонятно выражение "подпрограмма платы SW-01" непонятно. "Подпрограмма" - это часть программы, а не платы (см. хотя бы определение Википедии), следовательно, "подпрограммаы платы" быть не может, может быть "подпрограмма программы". По смыслу текста, здесь на самом деле подразумевается не "подпрограмма", а программа". Кроме этого, в тексте не уточняется, перезагрузка какой именно (под)программы произойдет. В плате SW-01 множество разных программ, поэтому без уточнения, какая именно программа перезапустится (а это программа swd), фраза несет для читателя мало полезной информации.
В соответствии с изложенным выше, предлагаю:
- заменить в тексте РЭ "подпрограмма" на "программа";
- уточнить, что имеется в виду именно программа swd.
Change History (7)
follow-up: 2 comment:1 by , 4 years ago
comment:2 by , 4 years ago
Replying to san:
Ещё отмечу что упоминание этой самой "программы swd" встречается местами в РЭ, но нигде не дано конкретное определение, что же это такое и зачем оно
Согласен, это нехорошо. Я неоднократно говорил, что излагать надо последовательно: сначала дать определение понятию, а потом его использовать.
Алексей, ты cможешь сформулировать такое описание?
Попробую...
Вот, посмотри #603.
follow-up: 5 comment:4 by , 4 years ago
В РЭ-42 в "6.2.30 Вкладка Разное / Перезапуск, Перезагрузка, Сменить пароль внёс изменения:"
"При нажатии кнопки Перезапуск появится запрос Перезапустить процесс swd?
При подтверждении произойдет перезагрузка программы swd платы SW-01"
"При истечении заданного таймеру времени будет выполнен рестарт программы swd."
Тут надо ли добавить "выполнен рестарт программы swd платы SW-01" ???
"При нажатии кнопки Перезагрузка произойдет полная перезагрузка программы swd SW-01
и выполнится также сброс всех остальных плат блока."
Тут надо "остальных плат блока" или "остальных программ блока" ???
comment:5 by , 4 years ago
Replying to Vladimir:
Тут надо ли добавить "выполнен рестарт программы swd платы SW-01" ???
Думаю, такой необходимости нет, так как выше такое уточнение уже есть. Более того, когда и если будет принято предложение тикета #603, даже добавленное выше уточнение не будет необходимым.
Тут надо "остальных плат блока" или "остальных программ блока" ???
Остальных плат блока.
comment:6 by , 4 years ago
| Resolution: | → готово |
|---|---|
| Status: | new → closed |
В РЭ-42 заменил "подпрограмма" на "программа" и добавил swd.
Тикет-603 уже закрыт.
Согласен с предложением. Ещё отмечу что упоминание этой самой "программы swd" встречается местами в РЭ, но нигде не дано конкретное определение, что же это такое и зачем оно, только намёки, как в процитированном фрагменте. Считаю что нужно дать пользователю понятное описание, назначения и функций swd, а затем в тексте просто называть её своим именем и давать ссылку.
Алексей, ты cможешь сформулировать такое описание?