РЭ: ошибочная ссылка на описание протокола Zabbix

[alx]

В РЭ аппаратуры MC04-DSL-3U редакции 37 в приложении 6 на странице 272 написано:

Более подробную информацию по протоколу Zabbix можно прочитать в статье на нашем сайте:

и далее указана ссылка на статью ​sw:ZabbixAgent.

Во-первых, в процитированном фрагменте РЭ слова "Более подробную" мне кажутся неуместными, так как протокол Zabbix в РЭ вообще не описан.

Во-вторых, статья, на которую указывает данная ссылка, не содержит описания протокола Zabbix вообще. То есть ссылка неверная. Протокол Zabbix описан в руководстве Zabbix, например ​здесь.

Предлагаю, во-первых, исключить слова "Более подробную", а во-вторых, скорректировать ссылку. Учитывая, что от версии к версии протокол может меняться, думаю, лучше вместо ссылки на конкретную страницу руководства просто написать "Описание протокола Zabbix смотрите в руководстве Zabbix".

[Vladimir]

В РЭ-38 записал такой текст:

"Описание протокола Zabbix смотрите в руководстве Zabbix, например, по ссылке:
​http://www.zabbix.com/documentation/4.2/ru/manual

Страницы помощи по Zabbix можно посмотреть по ссылке:
​http://www.zabbix.com/documentation/4.2/ru/manpages"

Все согласны с этим?

[Vladimir]

В тексте про руководство Zabbix указал ссылку на ТЕКУЩУЮ версию:

"Описание текущей версии протокола Zabbix можно посмотреть в руководстве Zabbix по ссылке: ​https://www.zabbix.com/documentation/current/"

[alx]

Replying to Vladimir:

Все согласны с этим?

С этим согласны, как минимум, не все. :)

Как я уже говорил устно, я не согласен.

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

Вторая причина (второстепенная) - на zabbix.com лежат руководства по Zabbix разных версий, и неизвестно, какой именно версией пользуется читатель (вовсе не обязательно он пользуется последним релизом).

[Vladimir]

1. А разве не может быть ситуации, когда читатель не использует Заббикс,

и даже никогда не слышал про него, но после прочтения по ссылке Руководство по Заббикс, читатель заинтересуется и он захочет использовать Заббикс?
Разве плохо заинтересовать читателя для использования удобной системы мониторинга?

2. Сразу после ссылки на текущую версию Заббикс я добавил примечание:

"(на сайте есть и предыдущие версии)"

Или тебе просто категорически не нравится Заббикс
и ты не хочешь косвенно рекламировать его ? :-)

[alx]

Replying to Vladimir:

1. А разве не может быть ситуации, когда читатель не использует Заббикс,

и даже никогда не слышал про него, но после прочтения по ссылке Руководство по Заббикс, читатель заинтересуется и он захочет использовать Заббикс?

Может.

Разве плохо заинтересовать читателя для использования удобной системы мониторинга?

Хорошо. Но, если ты поставил перед собой такую благую цель как заинтересовать читателя системой мониторинга, о которой он не знает, то почему из всех существующих систем мониторинга ты выбрал Zabbix и только Zabbix? ​Вот здесь хотя бы кроме Zabbix упоминаются еще 44 системы мониторинга. Неужели ни одна из них не может оказаться полезной читателю нашего РЭ? Я думаю, может. А если так, то, будучи последовательным в достижении поставленной цели, надо дать ссылки и на руководства по остальным системам тоже...

А теперь встречный вопрос: тот факт, что чем-то заинтересовать читателя - хорошо, является ли достаточным основанием для помещения этого чего-то в РЭ?

Или тебе просто категорически не нравится Заббикс
и ты не хочешь косвенно рекламировать его ? :-)

Zabbix мне нравится, но мне кажется, что перед руководством по эксплуатации аппаратуры MC04-DSL-3U не стоит задача косвенной рекламы системы мониторинга Zabbix. Я думаю, что перед нашим РЭ стоят иные задачи...

[san]

Я тоже не согласен с изменениями

Насколько я понял, цель исходной, упомянутой Алексеем, ссылки была не рассказать о системе Заббикс пользователю, а дать описание работы Zabbix агента встроенного в нашу аппаратуру
(​https://trac.adc-line.ru/sw-01/wiki/ZabbixAgent), но описание ссылки было неверным.

Сейчас, информация, доступная по вышеуказанной ссылке, уже включена в РЭ (так? ).
Поэтому ссылку на неё давать смысла нет.

По поводу ссылки на руководство к Заббиксу, согласен с мнением Алексея.

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

Тикет переоткрываю: ненужные ссылки надо исключить из РЭ.

[Vladimir]

Если бы в плате SW-01 были реализованы агенты всех 44 СУ,
то я, как добрый человек, вставил бы в РЭ ссылки на все 44 СУ -
мне это не жалко и не трудно:
это всего ОДНА лишняя страница из 307 страниц РЭ,
а для особо любопытного юзера это "Пустячок, а приятно!" :-)

А уж дать одну ссылку в мягкой форме мне кажется совсем микро-пустячок:

"Описание текущей версии протокола Zabbix можно посмотреть в руководстве Zabbix
по ссылке: ​https://www.zabbix.com/documentation/current/ (на сайте есть и предыдущие.
версии).

В документкции на сайте Zabbix есть ссылки на Руководство по Zabbix и Страницы помощи на русском языке (название ссылки «Zabbix documentation in Russian»).
"
Моё "Описание текущей версии протокола Zabbix можно посмотреть в руководстве Zabbix
по ссылке: ​https://www.zabbix.com/documentation/current/ (на сайте есть и предыдущие версии).

В документкции на сайте Zabbix есть ссылки на Руководство по Zabbix и Страницы помощи на русском языке (название ссылки «Zabbix documentation in Russian»).
"
Моё "можно посмотреть" не принуждает смотреть, т.е. можно и не смотреть,
это только для сведения читателя, у которого пока нет Заббикса,
если ему вдруг захочется подробнее познакомиться с возможностями Заббикс.
При капитализме предложение должно опережать спрос :-)

Вопрос к Саше: Оставить указанный выше текст про ссылки или удалить?

[alx]

Replying to Vladimir:

Если бы в плате SW-01 были реализованы агенты всех 44 СУ,
то я, как добрый человек, вставил бы в РЭ ссылки на все 44 СУ -
мне это не жалко и не трудно:
это всего ОДНА лишняя страница из 307 страниц РЭ,
а для особо любопытного юзера это "Пустячок, а приятно!" :-)

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

Во-вторых, непонятно, почему свою доброту ты вообще ставишь в зависимость от реализации каких-то агентов в какой-то плате? Ведь мониторить можно не только аппаратуру MC04-DSL-3U с платой SW-01, а много чего другого! Позволь вернуть тебе твой же аргумент: разве не может быть ситуации, когда читатель не использует (например) Nagios, и даже никогда не слышал про него, но после прочтения по ссылке Руководства по Nagios заинтересуется и захочет использовать Nagios? Разве плохо заинтересовать читателя использованием удобной системы мониторинга (даже если SW-01 и не содержала бы агента для нее)? :)

Моё "можно посмотреть" не принуждает смотреть, т.е. можно и не смотреть,
это только для сведения читателя, у которого пока нет Заббикса,
если ему вдруг захочется подробнее познакомиться с возможностями Заббикс.

Да, да! Твое "Можно посмотреть" не принуждает смотреть руководство по Cruz, Nagios, OpenNMS и т.д. Можно и не смотреть, это только для сведения читателя, у которого пока нет Cruz, Nagios, OpenNMS и т.д., если ему вдруг захочется подробнее познакомиться с возможностями Cruz, Nagios, OpenNMS и т. д. :)

Так что будь последователен и давай ссылки на роководства по всем остальным системам тоже.

[Vladimir]

В нашем РЭ-37 слово Zabbix встречается 49 раз,
а вот слова "Cruz, Nagios, OpenNMS" не встречаются ни одного раза,
так с какой стати тогда приводить ссылки на них?

А вот для 49 упоминаний Zabbix можно и привести одну ссылку на его подробное описание!

[Vladimir]

Подавляющим в 2 раза числом голосов я удалил ссылку на Заббикс из РЭ-38 :-)

[alx]

Replying to Vladimir:

так с какой стати тогда приводить ссылки на них?

Я только что писал, с какой стати, используя логику твоих аргументов, приведенных в comment:4. Но, так как ты спрашиваешь, повторю:

Разве не может быть ситуации, когда читатель не использует Cruz, Nagios и OpenNMS, и даже никогда не слышал про них, но после прочтения по ссылке Руководства по Cruz, Nagios и OpenNMS заинтересуется и захочет использовать Cruz, Nagios и OpenNMS? Разве плохо заинтересовать читателя использованием удобных систем мониторинга?

А вот для 49 упоминаний Zabbix можно и привести одну ссылку на его подробное описание!

А теперь давай серьезно. Предлагая разместить ссылки на все остальные существующие системы мониторинга, я апеллировал к логике твоих же аргументов, изложенных в comment:4. И там ничего не говорится о числе упоминаний той или иной системы. Таким образом, логика твоих аргументов в одинаковой степени применима как к Zabbix, так и к Cruz, Nagios и OpenNMS. Что я и показал, предложив довести ситуацию до абсурда, дав ссылки на все известные системы мониторинга. Верно ли я понимаю, что ты более не настаиваешь на этих аргументах? :)

Я даже больше скажу, твоя логика справедлива не только в отношении систем мониторинга, но и в отношении любых других (потенциально полезных) программ! Предложение дать ссылки на руководства всех остальных программ было бы моим следующим шагом, если бы ты не отказался следовать логике своих аргументов из comment:4 уже на первом шаге... :)

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

[alx]

Replying to Vladimir:

Подавляющим в 2 раза числом голосов я удалил ссылку на Заббикс из РЭ-38 :-)

Я разочарован... Получается, решение принято не исходя из аргументов и логики, а голосованием. Так мы и до подбрасывания монетки дойдем... :)

[Vladimir]

Ссылка на Заббикс- это не настолько важный вопрос, чтобы бороться за её внедрение,
можно обойтись и без ссылки.

Однако, кроме аргументов и логики должен быть и здравый смысл,
который мне говорит, что давать ссылки на то,
что ни одного раза не упоминается на 300 страницах,
бессмысленно (т.е. твой аргумент надуманный),
а вот если что-то упоминается 49 раз,
то вполне можно дать не обязательную ссылку для любознательных читателей.
Вот я бы обязательно открыл такую ссылку, чтобы хотя бы полистать статью,
и мне было бы приятно, что автор избавил меня от поиска в интернете
среди сотен или даже тысяч ссылок - это доброжелательность к читателю.
А ты бы не стал открывать, но текст РЭ и не обязывал открывать ссылку на Заббикс.

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

[alx]

Replying to Vladimir:

бессмысленно (т.е. твой аргумент надуманный),

Все верно, с одной только поправкой - это был твой аргумент (см. comment:4, заменив в нем "Заббикс" названием любой другой системы).

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

У нас получается не дискуссия, а хождение по кругу. :) Ты делаешь некое утверждение. В ответ я задаю дополнительный вопрос (прошу что-то пояснить). После чего ты, не отвечая на вопрос, повторяешь исходное утверждение. Тогда и я вынужден повторить свой вопрос, заданный в comment:11:

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

[Vladimir]

Все мои аргументы касались только ссылки на название Zabbix,
которое упоминается в тексте 49 раз - и это не надумано, а факт!

В научных статьях требуется обязательно давать ссылку,
если новое название чего-либо, например Nagios, даётся даже 1 раз,
а в РЭ названия Cruz, Nagios и OpenNMS и т.п. не встречаются ни одного раза!
Все мои аргументы касались только ссылки на название Zabbix,
которое упоминается в тексте 49 раз!

[alx]

Replying to Vladimir:

Все мои аргументы касались только ссылки на название Zabbix,

Мы опять ходим по кругу. :) Вынужден повторить то, что писал в comment:5. Да, в comment:4 ты приводил аргументы в пользу размещения в РЭ ссылки на руководство по Zabbix. Но приведенные тобой аргументы справедливы не только для Zabbix, но и не в меньшей мере для любой другой системы мониторинга. Замени в своем комментарии слово Zabbix например на OpenNMS, и они по-прежнему будут справедливы! Вот смотри:

А разве не может быть ситуации, когда читатель не использует OpenNMS, и даже никогда не слышал про него, но после прочтения по ссылке Руководство по OpenNMS, читатель заинтересуется и он захочет использовать OpenNMS? Разве плохо заинтересовать читателя для использования удобной системы мониторинга?

Ну так что, плохо разве? :) Поэтому, если ты будешь следовать логике собственных аргументов, ты должен будешь привести ссылку на руководство не только по Zabbix, но и на руководства по всем остальным существующим системам мониторинга тоже. Иначе будет нелогично, непоследовательно...

которое упоминается в тексте 49 раз - и это не надумано, а факт!

Я очередной раз перечитал твои аргументы, изложенные в comment:4. Не увидел там ни слова о количестве упоминаний той или иной системы мониторинга. Это - факт.

В научных статьях требуется обязательно давать ссылку,
если новое название чего-либо, например Nagios, даётся даже 1 раз,
а в РЭ названия Cruz, Nagios и OpenNMS и т.п. не встречаются ни одного раза!

Я немного потерял нить и логику...

Во-первых, какая связь между руководством по эксплуатации и научными статьями? Уверен, что когда и если ты будешь писать научную статью, ты добросовестно выполнишь все требования, предъявляемые к научным статьям. У меня нет в этом никаких сомнений. :) Но в данном тикете речь идет не о научной статье, а о руководстве по эксплуатации аппаратуры MC04-DSL-3U.

Во-вторых, я не вижу связи между двумя приведенными тобой фактами, поэтому из них не вытекает никакого вывода: если в научной статье не встречаются названия Cruz, Nagios и OpenNMS, значит условие обязательной ссылки не выполняется, то есть автор не обязан давать ссылку. Но при этом и нет запрета эту ссылку давать! Вот если бы, например, ты написал:

В научных статьях запрещено давать ссылку на руководство по чему-либо, название чего не упоминается в статье, а названия Cruz, Nagios и OpenNMS и т.п. не встречаются в статье ни одного раза//

то из этого следовал бы вывод, что в данной статье ссылок на руководства по Cruz, Nagios и OpenNMS быть не должно...

Все мои аргументы касались только ссылки на название Zabbix, которое упоминается в тексте 49 раз!

Ты опять повторяешь то, что уже писал ранее. Повторю свой ответ и я: твои аргументы, изложенные в comment:4, справедливы не только для Zabbix, но не в меньшей мере и для любой другой системы мониторинга.

[Vladimir]

А ты в Комменте-4 почему-то прицепился к моей незаконченной фразе,
т.к. я полагал, что ты сам домыслишь её :-) :

Надо было для тебя написать это чуть подробнее:

"Разве плохо заинтересовать читателя для использования удобной системы мониторинга
ZABBIX, т.к. она упоминается в тексте РЭ 49 раз?"

Тогда ты не мог бы ссылаться на другие СУ, которые не упоминаются ни разу :-)

Ну и зря я употребил глагол "заинтересовать", надо было написать:
"Разве плохо дать ссылку на ZABBIX, если читатель заинтересуется этой СУ
т.к. она упоминается в тексте РЭ 49 раз?"

На данный момент этой ссылки в РЭ-38 нет,
т.к. твой голос, как автора нашей СУ, более весомый, чем мой,
но вернуть не долго :-)

[alx]

Replying to Vladimir:

Надо было для тебя написать это чуть подробнее:

"Разве плохо заинтересовать читателя для использования удобной системы мониторинга
ZABBIX, т.к. она упоминается в тексте РЭ 49 раз?"

Хорошо. Спасибо за уточнение, но логику твоего аргумента это уточнение ничуть не меняет. Ты по-прежнему обосновываешь добавление ссылки в РЭ тем, что в этом нет ничего плохого. И мой ответ на это прежний - если тащить в РЭ все, в чем нет ничего плохого, мы очень далеко зайдем... :)

Задам встречный вопрос: что бы изменилось, если бы Zabbix упоминался не 49 а 48 раз? Разве Zabbix от этого перестал бы быть удобной системой мониторинга? Очевидно, что нет! Удобство Zabbix состоит не в том, что он упоминается в нашем РЭ 49 раз, а в его объективных свойствах. Или может в заинтересовывании им пользователя появится что-то плохое? Тоже нет, не появится...

А если бы Zabbix упоминался не 48 раз, а 47? Тоже ничего бы не изменилось. Рассуждая таким образом, мы дойдем до нуля и будем вынуждены признать, что в том, чтобы заинтересовать пользователя удобной системой мониторинга, нет ничего плохого независимо от того, сколько раз эта система упоминается в нашем РЭ!

Тогда ты не мог бы ссылаться на другие СУ, которые не упоминаются ни разу :-)

Я свободный человек, кто может мне это запретить? :) Просто мне в рассуждениях потребовался бы не один шаг, а два. На первом шаге выясняем, является ли число упоминаний Zabbix в РЭ существенным обстоятельством или нет. Выше я показал, что, по-моему, нет, не является. А на втором шаге мы приходим в исходную точку: нет ничего плохого не только в том, чтобы заинтересовать читателя системой Zabbix, но и в равной степени массой других систем тоже. Поэтому, если отсутствие плохого ты считаешь достаточным основанием для добавления текста в РЭ, следует добавить и все остальные удобные системы мониторинга тоже. Иначе это будет непоследовательное, выборочное следование заявленному принципу...

На данный момент этой ссылки в РЭ-38 нет,
т.к. твой голос, как автора нашей СУ, более весомый, чем мой,
но вернуть не долго :-)

??? Во-первых, ты меня, наверное, с кем-то путаешь... Судя по тому, что я не знаю, что такое "СУ", ее автор - не я. Я автор плат SW-01, VE-01 и VE-02. Во-вторых, мы же обсуждаем РЭ, а не какое-то СУ. Аавтор РЭ - ты, следовательно, и решение, что туда включать, а что нет, принимаешь ты. Я могу только высказать свое мнение, дать предложение, попытаться убедить тебя логикой аргументов, и не более...

[Vladimir]

Моё IMHO: в тексте описания по возможности лучше указать ссылки
на все названия, которые встречаются хотя бы 1 раз,
а упоминание в РЭ про Заббикс 49 раз только усиливает в 49 раз желание дать ссылку :-)

А вот Cruz, Nagios и OpenNMS, названия которых я увидел только от тебя,
не упоминаются ни разу, т.е. нет смысла указывать их даже в качестве примера...
Или у тебя в SW-01 уже есть тайные агенты этих систем? :-)

СУ - это общепринятое в РФ сокращённое название "Система управления",
в МС04-DSL-3U вообще и в платах SW-01, VE-01 и VE-02 и в ПО к ним в частности,
так или иначе реализована Система управления и мониторинга,
соавтором которой в значительной степени являешься ты.
Или ты ни коим образом не причастен к СУ МС04-DSL-3U
и даже не знаешь авторов/соавторов? :-)

Вот копия фрагмента Содержания РЭ на МС04-DSL-3U от первой до последней версии:

"6 СИСТЕМА УПРАВЛЕНИЯ ЦСП MC04−DSL
6.1 Подключение к блоку МС04-DSL-3U
6.1.1 Типовые схемы организации подключения
6.1.2 Установка соединения с блоком
6.2 Web-интерфейс управления блоком MC04-DSL-3U .... и т.д.
"

[alx]

Replying to Vladimir:

Моё IMHO: в тексте описания по возможности лучше указать ссылки
на все названия, которые встречаются хотя бы 1 раз,

Это уже совершенно другая аргументация, нежели данная в comment:4. Звучит разумно, и вот так вот сходу противоречий логике и здравому смыслу не вижу. :)

А вот Cruz, Nagios и OpenNMS, названия которых я увидел только от тебя,
не упоминаются ни разу, т.е. нет смысла указывать их даже в качестве примера...
Или у тебя в SW-01 уже есть тайные агенты этих систем? :-)

Тайных - нет. Есть явный. Ты зря читаешь мои комментарии выборочно. Потому что в comment:8 я написал о том, что, согласно данным таблицы на странице википедии, ссылку на которую я приводил ранее, 42 из 44 (не считая Zabbix) упомянутых там систем мониторинга поддерживают SNMP, агент которого есть в плате SW-01.

СУ - это общепринятое в РФ сокращённое название "Система управления",
в МС04-DSL-3U вообще и в платах SW-01, VE-01 и VE-02 и в ПО к ним в частности,
так или иначе реализована Система управления и мониторинга,
соавтором которой в значительной степени являешься ты.

Спасибо, теперь понятно. Да, СУ некоторыми из производимых нами плат я, действительно, делал. Но по-моему из этого факта вовсе не следует, что мое мнение по поводу текста РЭ более весомое, чем мнение автора. Тем более что в данном тикете речь о СУ вообще не идет... Систем же мониторинга я не делал. Нашу систему мониторинга делал Влад (а еще раньше Варя), и я к этому не имею никакого отношения.

[Vladimir]

Если "Звучит разумно, и вот так вот сходу противоречий логике и здравому смыслу не вижу.", то, по-твоему, ссылку на первоисточник Заббикс лучше бы вернуть в РЭ:
встречаются же любознательные читатели, которые захотят в одно касание поближе узнать возможности Заббикса ?

ИМХО: Влад и Варя создали начальный задел и очень давно,
а один из верных продолжателей и развивателей этого задела являешься ты,
т.е. ты соучастник современной версии нашей СУ и твой вклад неоценимо большой,
поэтому твоё мнение для меня имеет большой вес !

Гамлет бы сказал: "Вставить или не вставить - вот в чём вопрос!" :-)

[alx]

Replying to Vladimir:

Если "Звучит разумно, и вот так вот сходу противоречий логике и здравому смыслу не вижу.", то, по-твоему, ссылку на первоисточник Заббикс лучше бы вернуть в РЭ:
встречаются же любознательные читатели, которые захотят в одно касание поближе узнать возможности Заббикса ?

Нет.

ИМХО: Влад и Варя создали начальный задел и очень давно,
а один из верных продолжателей и развивателей этого задела являешься ты,

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

[Vladimir]

Тогда оставляю версию РЭ-38 без ссылки на первоисточник Заббикс.

А разве SW-01 и VE-01, VE-02 с учётом ПО не воплощают функции СУ ?

[alx]

Replying to Vladimir:

А разве SW-01 и VE-01, VE-02 с учётом ПО не воплощают функции СУ ?

Думаю, воплощают. Вообще СУ - понятие широкое, его можно на много чего натянуть. Выключатель на стене - это СУ светом... :)

[san]

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

[san]

Milestone deleted