Opened 5 years ago

Closed 2 years ago

Last modified 22 months ago

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

РЭ: неполное, неточное и непоследовательное описание подвкладки "Таблица коммутации"

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

Description

В РЭ аппаратуры MC04-DSL-3U редакции 39 в разделе 6.2.12 описана вкладка "Таблица коммутации" веб-интерфейса. Изложение информации в этом разделе мне кажется неполным и непоследовательным.

Например, текст раздела начинается со слов: "В верхней части вкладки расположено меню Режим TDM", но на приведенной иллюстрации я не вижу такого меню. Вероятно, имеется в виду панель с кнопками и чекбоксом, расположенная непосредственно над таблицей. Но о том, что именно эта панель называется "меню Режим TDM", у читателя нет никакой возможности догадаться, в результате он будет безуспешно искать надпись "Режим TDM" на картинке, пытаясь понять, где же это меню, о котором идет речь в тексте...

При перечислении содержимого подвкладки игнорируется панель "Передача бита целостности тракта", хотя она находится в самом верху, до "меню Режим TDM".

В описании условных обозначений таблицы коммутации объясняется только обозначение "2:3", хотя даже на приведенной картинке до него читатель видит другие обозначения (серые цифры "0", "1" и т.д.). Причем в обозначении "2:3" объясняется только значение первой цифры "2", а что означает цифра "3" для читателя остается загадкой. Обозначения, не показанные на картинке, но возможные в реальной жизни (например генерация в канал синусоиды 1 кГц или принудительная установка комбинации СУВ), вообще не описаны.

Здесь же объясняется обозначение значений СУВ с помощью маленьких и больших букв aBcD, не но поясняется, где же на подвкладке такие обозначения используются.

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

Я предлагаю переделать описание подвкладки "Таблица коммутации" следующим образом:

  • описывать элементы подвкладки в той последовательности, в которой они размещены на ней - сверху вниз слева направо;
  • описывать не выборочно, а полно, например описывать все возможные обозначения ячеек таблицы коммутации, а не только обозначение "2:3":


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

Attachments (1)

ss1.jpg (32.5 KB ) - added by alx 5 years ago.

Download all attachments as: .zip

Change History (28)

by alx, 5 years ago

Attachment: ss1.jpg added

comment:1 by alx, 5 years ago

Еще пример: в таблице 6.10 на странице 166 упоминаются выбранные каналы, а что это такое (какие каналы являются выбранными, почему, кто и как их выбирает) - для читателя загадка...

Предлагаю прежде чем оперировать понятием "выбранные каналы" дать вводную часть, где написать, что есть такая функция - выбор одного или нескольких каналов, для чего и в каких случаях она полезна, как можно выбрать каналы, как "развыбрать" (отменить выбор) и т.д.

comment:2 by san, 5 years ago

В описании условных обозначений таблицы коммутации объясняется только обозначение "2:3"

Я заметил, что и этот пример в корне неправильный:

цифры 2:3 в первой строке обозначают, что канальный интервал 3 (КИ3) первого потока Е1 коммутируется во второй поток Е1 (2Е1–КИ3).

На самом деле всё совсем наоборот.
Каждая ячейка в таблице коммутации соответствует каналу TDM. Канал может быть занят одной из плат блока или быть не занятым, в зависимости от настроек или места установки плат. Каналы, занятые платами, окрашены цветом отличным от фонового. Каждая ячейка(канал) имеет координаты в таблице, например 3:5 означает, что канал занимает таймслот 5 в третьем TDM потоке TDM коммутатора.
Коммутации каналов отображаются в таблице в виде координат ячеек синим цветом текста.
Например надпись 2:3 (смотри рисунок) в ячейке означает, что канал 2:3 скоммутирован в канал соответствующий рассматриваемой ячейке.

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

Replying to san:

Коммутации каналов отображаются в таблице в виде координат ячеек синим цветом текста.

Немного уточню. Цвет текста не обязательно синий. Синий он только в случае светлого фона. Но в половине случаев (в зависимости от номера слота, в который установлена плата) цвет фона ячеек темный, и тогда цвет текста - белый.

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

Replying to alx:

Например, текст раздела начинается со слов: "В верхней части вкладки расположено меню Режим TDM", но на приведенной иллюстрации я не вижу такого меню. ...

Это было записано в РЭ-25 от мая 2016г. и все последующие разработчики РЭ (а точнее редакторы), видимо, не знали или не заметили это изменение вкладки TDM, что является результатом того,
что, возможно, автор софта нигде не разместил ссылку на описание того, что он натворил с этой вкладкой :-)

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

А кто же это может знать лучше Автора софта?
Вот я про это и многое другое совсем ничего не знаю :-)
Что может написать тот, кто не знает про это? :-)

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

Replying to Vladimir:

А кто же это может знать лучше Автора софта?

Лучше Автора софта это может знать Автор этой функции, который ее придумал и реализовал.

Предвидя (с помощью магического хрустального шара) вопрос "А кто Автор этой функции, который ее предвидел и реализовал?", отвечаю - человек с ником anatoly. :)

Что может написать тот, кто не знает про это? :-)

Наверное то, что знает. :)

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

Replying to alx:

Replying to Vladimir:
Лучше Автора софта это может знать Автор этой функции, который ее придумал и реализовал.

  • человек с ником anatoly. :)

Вот этот anatoly и подсказал, к чему относится "панель настроек "Передача бита целостности""
и теперь в "Табл. 6.9 Описание установок меню вкладки Таблица коммутации" я записал так:
"Передача бита целостности тракта | Если галочка в чек-боксе установлена, то появляется таблица, предназначенная для резервирования отдельных канальных интервалов (см. Рис. 6.21).
Основной и резервный потоки Е1 можно выбрать в выпадающих меню колонки Управление для передачи бита целостности тракта (см. п.6.2.18) .
Аварии LOF или RAI описаны в Табл. 5.19.
Остальные замечания были учтены в РЭ-54.

Есть ли замечания, предложения, опровержения к такому тексту?

in reply to:  6 ; comment:7 by alx, 2 years ago

Replying to Vladimir:

Есть ли замечания, предложения, опровержения к такому тексту?

Рекомендую адресовать этот вопрос Автору этой функции, который ее придумал и реализовал. Кто же может это знать лучше Автора, который эту функцию придумал и реализовал? Это был риторический вопрос. :)

Last edited 2 years ago by alx (previous) (diff)

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

Replying to alx:

Replying to Vladimir:

Есть ли замечания, предложения, опровержения к такому тексту?

Рекомендую адресовать этот вопрос Автору этой функции, который ее придумал и реализовал. Кто же может это знать лучше Автора, который эту функцию придумал и реализовал? Это был риторический вопрос. :)

У каждого человека могут быть свои мнения по любому вопросы и это бывает интересно
и полезно узнать. Или у тебя есть своё мнение, но ты с ним не согласен? :-)
Кстати, мнение Автора: в РЭ всё и так понятно, ничего менять и не надо,
а тебе вот не всё нравится - и это хорошо! :-)
В СССР 90% людей были со всем согласны - а хорошо ли это было? :-)

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

in reply to:  8 ; comment:9 by alx, 2 years ago

Replying to Vladimir:

Есть ли замечания, предложения, опровержения к такому тексту?

У каждого человека могут быть свои мнения по любому вопросы

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

Замечания и предложения по ее описанию я уже дал в описании тикета.

in reply to:  9 comment:10 by Vladimir, 2 years ago

Resolution: готово
Status: newclosed

Replying to alx:

Replying to Vladimir:

Есть ли замечания, предложения, опровержения к такому тексту?

У каждого человека могут быть свои мнения по любому вопросы

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

Замечания и предложения по ее описанию я уже дал в описании тикета.

В РЭ-55 от 12.12.2022 учтены замечания и предложения Тикета-531
Анатолий Ч. согласился, что можно публиковать.

comment:11 by alx, 23 months ago

Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

in reply to:  11 ; comment:12 by Vladimir, 23 months ago

Replying to alx:

Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

В "Табл. 6.9 Описание установок меню вкладки Таблица коммутации" записано:
"Передача бита
целостности тракта | Если галочка в чек-боксе установлена, то появляется таблица, предназначенная для резервирования отдельных канальных интервалов (см. Рис. 6.21).
Основной и резервный потоки E1 можно выбрать в выпадающих меню колонки Управление для передачи бита целостности тракта (см. п. 6.2.19) .
Аварии LOF или RAI описаны в Табл. 5.19 "

В п.6.2.19 есть подпункт: "6.2.19.1 Механизм оценки состояния основного тракта."

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

У нас про 3U всё знает только 1 человек - САН,
Но и ты можешь попробовать предложить свой вариант описания про "Передача бита целостности тракта".
РЭ - это коллективное творчество: никто, кроме САН, не знает про 3U всё обо всём,
каждый может, если знает, предложить свой вариант улучшения РЭ :-)

in reply to:  12 ; comment:13 by alx, 23 months ago

Replying to Vladimir:

Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

я не могу судить о том, чего не знаю...

Как не знаешь? Ты не прочитал текст, который только что процитировал (не говоря уже о прочтении текста после внесения в него изменений)? :) Как это возможно?

Ну хорошо, прочитай его сейчас, я для тебя повторю:

Если галочка в чек-боксе установлена, то появляется таблица, предназначенная для резервирования отдельных канальных интервалов (см. Рис. 6.21).

Теперь ты знаешь этот текст и можешь о нем судить. Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

Last edited 23 months ago by alx (previous) (diff)

in reply to:  13 ; comment:14 by Vladimir, 23 months ago

Replying to alx:

Replying to Vladimir:

Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

я не могу судить о том, чего не знаю...

Теперь ты знаешь этот текст и можешь о нем судить. Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

Тебе же мало того текста, который уже напечатан в РЭ,
ты же хочешь узнать ответ на свой вопрос:
"Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

  • если ты не знаешь ответ, то я тем более не знаю, а если знаешь, то напиши! :-)

in reply to:  13 ; comment:15 by Vladimir, 23 months ago

Replying to alx:

Replying to Vladimir:

Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

Если галочка в чек-боксе установлена, то появляется таблица, предназначенная для резервирования отдельных канальных интервалов (см. Рис. 6.21).

Теперь ты знаешь этот текст и можешь о нем судить. Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

САН, проходя мимо меня, с первого взгляда сказал, что надо заменить ссылку (см. Рис. 6.21)
на ссылку (см. Рис. 6.18 Фрагмент вкладки Таблица коммутации, на котором есть чекбокс
"Передача бита целостности тракта").
Однако, мне кажется, что тут больше подходит "Рис. 6.35 Вкладка TDM/Таблица коммутации для бита целостности в 5E1 "
А ты, вместо кучи комментов, не мог это подсказать конкретную ссылку, если знаешь? :-)

Last edited 23 months ago by Vladimir (previous) (diff)

in reply to:  14 ; comment:16 by alx, 23 months ago

Replying to Vladimir:

ты же хочешь узнать ответ на свой вопрос:
"Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

Да, именно так. Это не риторический вопрос, и я задал его, так как хочу получить на него ответ.

  • если ты не знаешь ответ, то я тем более не знаю, а если знаешь, то напиши! :-)

Тогда, я не понимаю, зачем ты предлагаешь читателям, прочитавшим описание чекбокса "Передача бита целостности тракта", смотреть рисунок 6.21. В чем смысл?

in reply to:  15 ; comment:17 by alx, 23 months ago

Replying to Vladimir:

А ты, вместо кучи комментов, не мог это подсказать, если знаешь? :-)

Я подсказать не мог, так как не знаю. Я, в отличие от san, телепатией не владею, и поэтому не мог знать, что, когда ты написал "см. Рис. 6.21", ты на самом деле имел в виду в виду рисунок 6.18... Кстати, ты сам-то это знал, так почему же тогда сразу в ответ на мой comment:11 не написал, что тут ошибка, и на самом деле имелся в виду другой рисунок? Это бы избавило нас от написания кучи последующих комментов...

Last edited 23 months ago by alx (previous) (diff)

in reply to:  17 ; comment:18 by Vladimir, 23 months ago

Replying to alx:

Replying to Vladimir:

А ты, вместо кучи комментов, не мог это подсказать, если знаешь? :-)

Я подсказать не мог, так как не знаю. Я, в отличие от san, телепатией не владею,

САН опирается не на телепатию, а на смысл: он искал подходящий по смыслу номер рисунка в РЭ,
увидел чекбокс "Передача бита целостности тракта" на Рис.6.18 - его и назвал,
а мне кажется, что ещё больше по смыслу подойдёт, например, Рис.6.35.
А по твоему смыслу Рис.6.35 тоже больше подходит?

и поэтому не мог знать, что, когда ты написал "см. Рис. 6.21", ты на самом деле имел в виду в виду рисунок 6.18... Кстати, ты сам-то это знал, так почему же тогда сразу в ответ на мой comment:11 не написал, что тут ошибка, и на самом деле имелся в виду другой рисунок? Это бы избавило нас от написания кучи последующих комментов...

Так и я не знал, поэтому и спросил у САН и он за 10 секунд нашёл Рис.6.18,
на котором есть чекбокс "Передача бита целостности тракта",
а я решил ещё дальше посмотреть и нашёл Рис.6.35.

in reply to:  16 ; comment:19 by Vladimir, 23 months ago

Replying to alx:

Replying to Vladimir:

ты же хочешь узнать ответ на свой вопрос:
"Каким образом рисунок 6.21 поясняет описание чекбокса "Передача бита целостности тракта"?

Тогда, я не понимаю, зачем ты предлагаешь читателям, прочитавшим описание чекбокса "Передача бита целостности тракта", смотреть рисунок 6.21. В чем смысл?

Это была опечатка или ошибка - у всех бывает, а у тех, кто первый раз пишет про это, бывает чаще :-)
Поэтому читай мои тексты максимально критически, что ты и делаешь :-)

in reply to:  17 ; comment:20 by san, 23 months ago

Replying to alx:

Я, в отличие от san, телепатией не владею

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

in reply to:  18 comment:21 by alx, 23 months ago

Replying to Vladimir:

САН опирается не на телепатию, а на смысл:

А ты, когда предлагал смотреть рис. 6.21, на что опирался? Разве не на смысл?

Вот и я предположил, что ты тоже опирался на смысл, и что предложение посмотреть этот рисунок наверное было сделано не случайно. Возможно, я просто по каким-то причинам я этого смысла не понял, не разглядел... Поэтому и обратился к тебе с вопросом. Может быть (как я мыслил, задавая вопрос), ответ будет такой убедительный, что я сразу соглашусь - что да, этот рисунок очень хорошо иллюстрирует описание, и без него назначение чекбокса вообще трудно понять... А вот отвергать сходу все, что мне непонятно, я как раз не считаю разумным и правильным...

а мне кажется, что ещё больше по смыслу подойдёт, например, Рис.6.35.
А по твоему смыслу Рис.6.35 тоже больше подходит?

Да, мне кажется, что рисунок 6.35 более информативный. К тому же рисунок 6.18 размещен до таблицы 6.9, поэтому читающий таблицу его и так, скорее всего, уже видел.

и поэтому не мог знать, что, когда ты написал "см. Рис. 6.21", ты на самом деле имел в виду в виду рисунок 6.18...

Так и я не знал,

??? Это как так? Ты не знал, какой рисунок ты же сам решил предложить смотреть читателю? Как такое возможно?

in reply to:  19 comment:22 by alx, 23 months ago

Replying to Vladimir:

Тогда, я не понимаю, зачем ты предлагаешь читателям, прочитавшим описание чекбокса "Передача бита целостности тракта", смотреть рисунок 6.21. В чем смысл?

Это была опечатка или ошибка - у всех бывает,

Безусловно, бывает у всех. Просто странно, что ты не сказал об этом сразу в comment:12, и в результате мы понаписали здесь еще целую кучу комментов... :)

Last edited 23 months ago by alx (previous) (diff)

in reply to:  20 comment:23 by alx, 23 months ago

Replying to san:

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

О, спасибо за разъяснение. В твоей версии, действительно, и телепатии нет, и вообще она существенно отличается от версии, изложенной Vladimir в comment:15... :)

in reply to:  20 comment:24 by Vladimir, 22 months ago

Replying to san:

Replying to alx:

Я, в отличие от san, телепатией не владею

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

Ты показал на Рис.6.18, а мне кажется, что ссылка, например, на Рис.6.35 больше подходит - согласен?

comment:25 by san, 22 months ago

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

in reply to:  25 comment:26 by Vladimir, 22 months ago

Replying to san:

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

Хорошо, Алекс в комменте-21 подтвердил, что
"Да, мне кажется, что рисунок 6.35 более информативный.",
поэтому в РЭ-56 от 17.01.2023 записал ссылку на Рис.6.35.

comment:27 by san, 22 months ago

milestone: 1 очередь

Milestone deleted

Note: See TracTickets for help on using tickets.