#647 closed дефект (готово)
РЭ: неверный падеж в описании рег.выражения набора
Reported by: | alx | Owned by: | Vladimir |
---|---|---|---|
Priority: | major | Component: | Руководство по эксплуатации |
Keywords: | Cc: |
Description
В РЭ аппаратуры MC04-DSL-3U редакции 42 на странице 206 есть такой текст:
Если же совпадения с регулярным выражением не произошло, вызов будет отправлен по истечению таймаута набора очередной цифры.
Здесь слово "истечение" должно быть в предложном падеже. Предлагаю исправить.
Change History (19)
follow-up: 2 comment:1 by , 4 years ago
follow-up: 4 comment:3 by , 4 years ago
Запишу я, но согласен ли ты с такой формулировкой,
правильно ли я записал, заменив неправильное слово "по истечению таймаута"
на "после таймаута"?
follow-up: 5 comment:4 by , 4 years ago
Replying to Vladimir:
Запишу я, но согласен ли ты с такой формулировкой,
Согласен. Действительности не противоречит.
правильно ли я записал, заменив неправильное слово "по истечению таймаута"
на "после таймаута"?
Вообще-то я не предлагал заменить слово "истечение", я лишь предлагал изменить его падеж на правильный. Но если ты по каким-то неизвестным мне причинам хочешь его заменить, я не возражаю.
follow-ups: 6 12 comment:5 by , 4 years ago
Resolution: | → готово |
---|---|
Status: | new → closed |
Replying to alx:
Replying to Vladimir:
Запишу я, но согласен ли ты с такой формулировкой,
Согласен. Действительности не противоречит.
правильно ли я записал, заменив неправильное слово "по истечению таймаута"
на "после таймаута"?
Вообще-то я не предлагал заменить слово "истечение", я лишь предлагал изменить его падеж на правильный. Но если ты по каким-то неизвестным мне причинам хочешь его заменить, я не возражаю.
Причины простые: "после" - короче и понятнее, чем "по истечении" (5 букв вместо 12 знаков) :-) (с "по истечении" у меня слово "Примеры" перескакивало на следующую строчку,
состоящую из одного слова "Примеры"):
Сейчас в РЭ-43 будет так:
"...вызов будет отправлен после таймаута набора очередной цифры. Примеры:"
follow-up: 7 comment:6 by , 4 years ago
Replying to Vladimir:
Причины простые: "после" - короче
У нас, например, в п. 7.4.4 упоминается вкладка "Установки ДВО", даже картинка ее приведена, но не описываются ее элементы. А потом в п. 7.4.14 снова описывается эта же вкладка, на этот раз уже с описанием ее содержимого. И, кстати, снова приведена картинка. Зачем, в таком случае, был нужен пункт 7.4.4? Если ты хочешь сократить объем РЭ, лучше выброси пункт 7.4.4 - экономия будет раз в 100 больше, чем жалкие 7 букв от замены "по истечении" на "после"...
и понятнее,
Это еще более странная причина... Чем же "по истечении" может быть непонятно?
follow-ups: 8 9 comment:7 by , 4 years ago
Replying to alx:
Replying to Vladimir:
Причины простые: "после" - короче
У нас, например, в п. 7.4.4 упоминается вкладка "Установки ДВО", даже картинка ее приведена, но не описываются ее элементы. А потом в п. 7.4.14 снова описывается эта же вкладка, на этот раз уже с описанием ее содержимого. И, кстати, снова приведена картинка. Зачем, в таком случае, был нужен пункт 7.4.4? Если ты хочешь сократить объем РЭ, лучше выброси пункт 7.4.4.
На Рис.7.13 показаны 4 вкладки и пункты описания идут в этом же порядке:
Параметры - п.7.4.1,
Настройки медиа - п.7.4.2,
Т.38 - п.7.4.3
Установки ДВО - п.7.4.4 - это логично, поэтому удалять п.7.4.4 нельзя,
кроме того, ДВО много раз упоминается в пп.7.4.11, .12, .13.
Наверное, можно тогда удалить п.7.4.14, но дополнить из него описание п.7.4.4.
Только п.7.4.14 очень большой, содержит 7 подпунктов 7.4.14.1....7.4.14.7
А есть и ещё 1 пункт про ДВО:
"7.8 Вкладка ДВО – Настройка ДВО (дополнительных видов обслуживания)"
но это совсем в другом окне - это тоже надо втиснуть в п.7.4.4 ?
(в п.7.4.4 впервые показана вкладка ДВО).
и понятнее,
Это еще более странная причина... Чем же "по истечении" может быть непонятно?
5 букв быстрее дойдут до сознания, чем 12 :-)
К тому же говорят: "Краткость - сестра таланта!" :-)
comment:8 by , 4 years ago
Replying to Vladimir:
А есть и ещё 1 пункт про ДВО:
"7.8 Вкладка ДВО – Настройка ДВО (дополнительных видов обслуживания)"
но это совсем в другом окне - это тоже надо втиснуть в п.7.4.4 ?
Надо кому? Мне не надо. Я даже еще не читал этот пункт. Я лишь указал на некоторую, как мне кажется, непоследовательность: сначала ты дважды описываешь (с картинкой!) одну и ту же вкладку, а потом в другом месте изменяешь текст чтобы сэкономить 7 символов... Мне такая экономия кажется просто смешной... :)
Чем же "по истечении" может быть непонятно?
5 букв быстрее дойдут до сознания, чем 12 :-)
Шутку оценил. :)
follow-up: 10 comment:9 by , 4 years ago
Replying to Vladimir:
На Рис.7.13 показаны 4 вкладки и пункты описания идут в этом же порядке:
Параметры - п.7.4.1,
Настройки медиа - п.7.4.2,
Т.38 - п.7.4.3
Установки ДВО - п.7.4.4 - это логично, поэтому удалять п.7.4.4 нельзя,
Стремление следовать логике меня очень радует. А теперь смотри, что получилось. Читатель видит, что есть 4 вкладки. Описывается первая вкладка, и все элементы, которые на ней находится: парамерт такой-то делает то-то, параметр сякой-то делает се-то... и так все от первого до последнего. Вторая вкладка - то же самое. Третья вкладка - то же самое. Четвертая вкладка - написано для чего она, и на этом все, раздел кончился, дальше идет другая тема. При том что на картинке читатель видит целую кучу конфигурационных элементов - одних только чекбоксов больше десятка... Что должен подумать читатель? Что о назначении всех этих элементов ему предлагается догадаться самостоятельно! О том, что через 6-7 страниц на другую тему повествование снова вернется к описанию этой вкладки, догадаться по-моему довольно трудно...
follow-up: 11 comment:10 by , 4 years ago
Replying to alx:
Replying to Vladimir:
На Рис.7.13 показаны 4 вкладки и пункты описания идут в этом же порядке:
Параметры - п.7.4.1,
Настройки медиа - п.7.4.2,
Т.38 - п.7.4.3
Установки ДВО - п.7.4.4 - это логично, поэтому удалять п.7.4.4 нельзя,
Стремление следовать логике меня очень радует. А теперь смотри, что получилось. Читатель видит, что есть 4 вкладки. Описывается первая вкладка, и все элементы, которые на ней находится: парамерт такой-то делает то-то, параметр сякой-то делает се-то... и так все от первого до последнего. Вторая вкладка - то же самое. Третья вкладка - то же самое. Четвертая вкладка - написано для чего она, и на этом все, раздел кончился, дальше идет другая тема. При том что на картинке читатель видит целую кучу конфигурационных элементов - одних только чекбоксов больше десятка... Что должен подумать читатель? Что о назначении всех этих элементов ему предлагается догадаться самостоятельно! О том, что через 6-7 страниц на другую тему повествование снова вернется к описанию этой вкладки, догадаться по-моему довольно трудно...
Т.е. ты согласен, что будет лучше и понятнее, если содержимое п.7.4.14 и всех его 7 подпунктов 7.4.14.1....7.4.14.7 перетащить в п.7.4.4, а 7.4.14 ликвидировать
и не видишь в этом недостатков?
follow-up: 13 comment:11 by , 4 years ago
Replying to Vladimir:
Стремление следовать логике меня очень радует.
Т.е. ты согласен, что будет лучше и понятнее, если содержимое п.7.4.14 и всех его 7 подпунктов 7.4.14.1....7.4.14.7 перетащить в п.7.4.4, а 7.4.14 ликвидировать
и не видишь в этом недостатков?
Нет.
Поясню, почему нет: я согласен, что будет лучше и понятнее, если содержимое п.7.4.14 и всех его 7 подпунктов 7.4.14.1....7.4.14.7 перетащить в п.7.4.4, а 7.4.14 ликвидировать. Однако я вижу в этом недостатки. Насколько я мог заметить, описание большинства плат в РЭ строится по определенной схеме: сначала описано назначение платы, затем выполняемые ей функции (как это все работает), затем подключение к ней внешних цепей, и, наконец, как она настраивается/конфигурируется. Следование при описании плат одной и той же схеме - это хорошо и правильно, это удобно для читателя, так как в хорошо структурированном документе ему легче искать нужную информацию. Но вот в случае плат VE-01 и VE-02 эта схема почему-то нарушается - описания функционирования и конфигурирования перемешаны между собой. Это - недостаток, который я вижу.
comment:12 by , 4 years ago
Replying to Vladimir:
Причины простые: "после" - короче
Вот только что нашел еще пример: конфигурационный параметр "Длительность паузы" канального окончания FXS плат VE-01/VE-02 описан дважды: один раз на странице 217, и еще один раз - на странице 232. Первое описание содержит 707 символов, второе - 733. Это В СТО РАЗ больше, чем ты сэкономил, заменяя "по истечении" на "после". Да, я знаю, что повтор описания параметра очень важен: повторение - мать учения, и так далее... Но после этого говорить об экономии 7 символов - просто смешно... :) Еще 99 таких замен - и золотой ключик у нас в кармане и мы наверстаем объем, потраченный на повторное описание "длительности паузы"! :)
follow-up: 14 comment:13 by , 4 years ago
Replying to alx:
Replying to Vladimir:
Т.е. ты согласен, что будет лучше и понятнее, если содержимое п.7.4.14 и всех его 7 подпунктов 7.4.14.1....7.4.14.7 перетащить в п.7.4.4, а 7.4.14 ликвидировать
и не видишь в этом недостатков?
Нет.
В данном случае это неоднозначный ответ:
твоё "Нет" можно понять, как "Нет, не вижу недостатков",
хотя ты их видишь :-)
Следование при описании плат одной и той же схеме - это хорошо и правильно, Но вот в случае плат VE-01 и VE-02 эта схема почему-то нарушается - описания функционирования и конфигурирования перемешаны между собой. Это - недостаток, который я вижу.
Это сложилось исторически:
от Толи я получил РЭ-28 на 16 Мбайт (сейчас уже 92 Мбайт) и структура там была другая:
сначала было 76 страниц описание только железа, а потом 100 страниц было про:
"4 СИСТЕМА УПРАВЛЕНИЯ И МОНИТОРИНГА БЛОКА MC04−DSL−3U", внутри которой был раздел
"4.4 Управление и мониторинг плат блока", но АЕН сначала поставил задачу разбить РЭ на отдельные самостоятельные книжечки по каждой плате, а МВН настаивал на общем РЭ для всех плат и я предложил компромисс: совместить описание железа плат и настройку, чтобы при желании можно было распечатать описание и настройку в одной книжечке: АЕН и МВН согласились.
А вот для плат VE описание и настройка оказались слишком большими по числу станиц - около сотни и продолжает расти, поэтому делать такую большую вставку в начале РЭ (со стр.58),
а потом продолжать описание остальных плат было бы не очень удобно юзерам с бумажными РЭ и большинству тех, кто с платами VE не работает (много проектов без VE), поэтому я и решил выделить это в пункт "7 УПРАВЛЕНИЕ ГОЛОСОВЫМ ШЛЮЗОМ VE-01, VE-02" (стр.203)
и с этим согласились все, кого я спрашивал (и возражений не было).
Как вариант (если согласится Саша и Директор), можно и описание железа перенести из
"5.8 Плата VE-01 (голосовой шлюз с функциями IP-АТС)" и
"5.9 Плата VE-02 (голосовой шлюз с функциями IP АТС + внешние интерфейсы)"
перенести в раздел 7, который обозвать короче: "7 ГОЛОСОВЫЕ ШЛЮЗЫ VE-01, VE-02",
тебе нравится Такой вариант?
follow-up: 15 comment:14 by , 4 years ago
Replying to Vladimir:
Нет.
В данном случае это неоднозначный ответ:
Моей фантазии не хватает чтобы придумать более однозначный ответ чем "нет". :) Может быть "да"? :)
твоё "Нет" можно понять, как "Нет, не вижу недостатков",
хотя ты их видишь :-)
И??? Тебе остался малюсенький шажок чтобы сделать какой-то вывод из этого факта. Поднажми!... :)
Как вариант (если согласится Саша и Директор), можно и описание железа перенести из
"5.8 Плата VE-01 (голосовой шлюз с функциями IP-АТС)" и
"5.9 Плата VE-02 (голосовой шлюз с функциями IP АТС + внешние интерфейсы)"
перенести в раздел 7, который обозвать короче: "7 ГОЛОСОВЫЕ ШЛЮЗЫ VE-01, VE-02",
тебе нравится Такой вариант?
Нет. Не вижу пользы от такого переноса.
follow-up: 16 comment:15 by , 4 years ago
Replying to alx:
Replying to Vladimir:
Нет.
В данном случае это неоднозначный ответ:
Моей фантазии не хватает чтобы придумать более однозначный ответ чем "нет". :) Может быть "да"? :)
твоё "Нет" можно понять, как "Нет, не вижу недостатков",
хотя ты их видишь :-)
И??? Тебе остался малюсенький шажок чтобы сделать какой-то вывод из этого факта. Поднажми!... :)
На вопрос "...и не видишь в этом недостатков?" оба ответа Да и Нет неудачные:
"Нет, не вижу недостатков"
"Да, не вижу недостатков" имеют одинаковый смысл,
поэтому требуется короткий, но более полный ответ, например:
"Вижу, что недостатки есть", "Да, не вижу недостатков".
Как вариант (если согласится Саша и Директор), можно и описание железа перенести из
"5.8 Плата VE-01 (голосовой шлюз с функциями IP-АТС)" и
"5.9 Плата VE-02 (голосовой шлюз с функциями IP АТС + внешние интерфейсы)"
перенести в раздел 7, который обозвать короче: "7 ГОЛОСОВЫЕ ШЛЮЗЫ VE-01, VE-02",
тебе нравится Такой вариант?
Нет. Не вижу пользы от такого переноса.
Тогда польза остаётся только в переносе содержимого п.7.4.14 и всех его 7 подпунктов 7.4.14.1....7.4.14.7 в п.7.4.4, а 7.4.14 ликвидировать.
Однако, мы ушли от темы этого давно закрытого Тикета о падежах,
поэтому я попробую открыть новый тикет о компоновке материала по платам VE-01/VE-02.
follow-up: 17 comment:16 by , 4 years ago
Replying to Vladimir:
На вопрос "...и не видишь в этом недостатков?"
Ну вообще-то твой вопрос был не такой. Но сейчас не об этом.
оба ответа Да и Нет неудачные:
Вот напасть какая... Мало того, что ответ "нет" - неоднозначный, так он еще и неудачный! Ну что за невезенье - удача обошла меня стороной... :(
поэтому требуется короткий, но более полный ответ,
... и этот ответ тебе был дан, не так ли?
follow-up: 18 comment:17 by , 4 years ago
Для обсуждения и исправления пунктов про ДВО я создал новый Тикет:
#656 new улучшение
РЭ: компоновка материала по платам VE-01, VE-02.
Правильно ли я оформил этот Тикет?
comment:18 by , 4 years ago
Replying to Vladimir:
Правильно ли я оформил этот Тикет?
Нет никаких формальных правил оформления тикетов. Главное - руководствоваться здравым смыслом. Есть разве что вот такие рекомендации, но это для случая, когда кто-то нашел баг, и хочет сообщить о нем разработчикам. А когда пишешь тикет для себя - лишь бы самому понятно было...
Replying to alx:
Предлагаю записать так:
"Если же совпадения с регулярным выражением не произошло, вызов будет отправлен после таймаута набора очередной цифры."