Opened 7 years ago

Closed 6 years ago

Last modified 23 months ago

#134 closed улучшение (не будем делать)

Новая структура РЭ

Reported by: andrei Owned by: Vladimir
Priority: critical Component: Руководство по эксплуатации
Keywords: Cc: san, alx, Director, viktam, artem, Vladimir

Description

Изменяем структуру описания.
Предварительная структура по ссылке.
https://docs.google.com/document/d/1xHL-Z1j_zHYpEaciFxgrXu4gY9Rz-3cJ5ma_X5-A27I/edit?usp=sharing

Change History (32)

comment:1 by alx, 7 years ago

Наверное имеет смысл описание отдельных плат поместить после общей вводной части. А то получается, что сначала описывается, как конфигурировать, например, плату SM-01, а потом читателю сообщают, что у блока есть веб-интерфейс, с помощью которого можно конфигурировать платы! :)

comment:2 by alx, 7 years ago

Supervisor'у здесь, однозначно, не место. Отдельный продукт - отдельное руководство.

comment:3 by andrei, 7 years ago

Перед веб-интерфейсом плата SW и питательные платы, все остальные вынесены ниже (или в отдельный документ)
По супервизору - принято.

in reply to:  2 ; comment:4 by san, 7 years ago

Supervisor'у здесь, однозначно, не место. Отдельный продукт - отдельное руководство.

Согласен
Но предлагаю вместо этой главы создать главу "Мониторинг" где описать возможные способы мониторинга блока 3u и соответствующие настройки блока.

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

Replying to san:

Но предлагаю вместо этой главы создать главу "Мониторинг"

Там уже есть место, где описываются вкладки веб-интерфейса. В описании вкладки "Мониторинг" все это можно описать.

comment:6 by andrei, 7 years ago

Опишу мониторинг в двух местах

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

Replying to andrei:

Перед веб-интерфейсом плата SW и питательные платы, все остальные вынесены ниже

Ну так для платы PS-220 будет та же ерунда: сначала описано, как она конфигурируется, а потом, ниже, сообщается, что есть веб-интерфейс... Не лучше ли описание ВСЕХ плат перенести ниже общей части, независимо от того, как эти платы потом будут (если будут) группироваться?

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

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

Replying to andrei:

Опишу мониторинг в двух местах

:) :) :) Почему не в семи? :) В чем смысл дублирования?

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

in reply to:  7 comment:9 by andrei, 7 years ago

Replying to alx:

Replying to andrei:

Перед веб-интерфейсом плата SW и питательные платы, все остальные вынесены ниже

Ну так для платы PS-220 будет та же ерунда: сначала описано, как она конфигурируется, а потом, ниже, описано, сообщается, что есть веб-интерфейс... Не лучше ли описание ВСЕХ плат перенести ниже общей части, независимо от того, как эти платы потом будут (если будут) группироваться?

Я-то как раз согласен и тоже так хотел бы

in reply to:  8 comment:10 by andrei, 7 years ago

Replying to alx:

Replying to andrei:

Опишу мониторинг в двух местах

:) :) :) Почему на в семи? :) В чем смысл дублирования?

Чтобы все было "перед глазами" и не требовало утомительного поиска.
До абсурда постараюсь не доводить.

comment:11 by alx, 7 years ago

Пункт 6.1 - нет у нас специальной поддержки для Supervisor. У нас есть только SNMP, ИСУМ и zabbix. Насколько я знаю, Supervisor использует SNMP.

comment:12 by alx, 7 years ago

Может нужен раздел "утилизация"?

in reply to:  11 ; comment:13 by andrei, 7 years ago

Replying to alx:

Пункт 6.1 - нет у нас специальной поддержки для Supervisor. У нас есть только SNMP, ИСУМ и zabbix. Насколько я знаю, Supervisor использует SNMP.

Но для мониторинга аппаратуры использовать супервизор можно и он наиболее часто используется на данный момент, ИМХО. Насколько знаю я использование SNMP супервизором - лишь частный случай (Саша, расскажи нам правду!).
Так что этот пункт оставлю, в нем кратко опишу, а подробное описание в отдельном документе существует.

Может нужен раздел "утилизация"?

Да, можно добавить. Надо подумать.

in reply to:  13 ; comment:14 by alx, 7 years ago

Replying to andrei:

Но для мониторинга аппаратуры использовать супервизор можно

По этой логике надо добавить еще пол-сотни разделов - каждый посвятить одной из существующих систем мониторинга, поддерживающей SNMP!

и он наиболее часто используется на данный момент, ИМХО.

ИМХО в top 40 не входит:

https://en.wikipedia.org/wiki/Comparison_of_network_monitoring_systems

И потом, если он такой распространенный, что потребитель аппаратуры 3U его уже использует, то у него (потребителя) уже есть руководство на Supervisor. Не понимаю, зачем дублировать его (пусть даже кратко) в РЭ на совсем другое изделие...

Насколько знаю я использование SNMP супервизором - лишь частный случай (Саша, расскажи нам правду!).

Безусловно, это частный случай. Поэтому я и считаю, что такой раздел в РЭ на 3U - лишний.

Так что этот пункт оставлю, в нем кратко опишу, а подробное описание в отдельном документе существует.

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

comment:15 by san, 7 years ago

Supervisor использует апи-команды через http и snmp-трапы.
Программа Cупервизор создана специально для мониторинга оборудования MC04, думаю уместно её упомянуть и в описании этого самого оборудования.

Last edited 7 years ago by san (previous) (diff)

in reply to:  14 ; comment:16 by san, 7 years ago

и он наиболее часто используется на данный момент, ИМХО.

ИМХО в top 40 не входит:

Андрей имел ввиду, что наиболее часто для мониторинга MC04-3U используется Supervisor, и он прав.
По моим оценкам более 90% блоков 3U мониторятся им и только им.

in reply to:  15 ; comment:17 by alx, 7 years ago

Replying to san:

Программа Cупервизор создана специально для мониторинга оборудования MC04,

??? =8-()

думаю уместно её упомянуть и в описании этого самого оборудования.

Против упоминания я не возражаю. Наряду с другими существующими системами мониторинга упомянуть ее можно. Непонятно, зачем ради простого упоминания создавать целый раздел...

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

in reply to:  16 comment:18 by alx, 7 years ago

Replying to san:

Андрей имел ввиду, что наиболее часто для мониторинга MC04-3U используется Supervisor, и он прав.
По моим оценкам более 90% блоков 3U мониторятся им и только им.

Это не аргумент для включения в РЭ на блок 3U раздела Supervisor. Повторю: раз некто уже использует Supervisor, причем именно для мониторинга блоков 3U, значит у него мало того что уже есть РЭ на Supervisor, так еще и уже есть РЭ на блок 3U. Такому пользователю упоминание того факта, что блоки 3U можно мониторить с помощью программы Supervisor, не требуется - он это и так уже знает!!!

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

in reply to:  17 ; comment:19 by san, 7 years ago

??? =8-()

Это удивление ?))

Это не аргумент

Это к спору про топ 40, считай что Андрей делает в описании ТОП-5 систем мониторинга для аппаратуры 3U :)

in reply to:  19 comment:20 by alx, 7 years ago

Replying to san:

Это удивление ?))

Да.

Это не аргумент

Это к спору про топ 40,

У нас нет спора о том, входит ли Supervisor в top 40 систем мониторинга или нет. :) Спор о том, следует ли включать его (и только его) упоминание в виде раздела в РЭ на блок 3U.

считай что Андрей делает в описании ТОП-5 систем мониторинга для аппаратуры 3U :)

Так считать довольно сложно - я не вижу в предлагаемом оглавлении пяти систем мониторинга. :)

Считаю, что в РЭ на блок надо описывать то, что непосредственно касается блока. Выбор системы мониторинга - это отдельный БОЛЬШОЙ вопрос, который мы своими "упоминаниями" решить не поможем. Ведь, к примеру, не упоминаем же мы в руководстве top 5 стоек/шкафов для установки аппаратуры! Мы просто пишем, что аппаратура устанавливается в 19" стойки, и все...

comment:21 by san, 7 years ago

Выбор системы мониторинга - это отдельный БОЛЬШОЙ вопрос, который мы своими "упоминаниями" решить не поможем.

В общем я с тобой согласен. Но часто бывает случай когда пользователь хочет получить конкретный ответ: "Как мониторить эту аппаратуру", он открывает оглавление, находит раздел Мониторинг и видит там наши возможности: поддержку snmp,кпо, Zabbix-агент, ?web-api?. Просто и понятно и не надо искать эту информацию где-то в настройках вкладок.

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

Last edited 7 years ago by san (previous) (diff)

in reply to:  21 comment:22 by alx, 7 years ago

Replying to san:

В общем я с тобой согласен.
...он открывает оглавление... и видит там... поддержку snmp,кпо, Zabbix-агент, ?web-api?.

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

в рекламных целях.

Не могу согласиться. Всему должно быть свое место. Место для рекламы - веб-сайт, блог, страницы в соцсетях, ролики на ТВ и радио... А руководство по эксплуатации - это место, где описывается, как пользоваться конкретным устройством. Рекламе там не место. Как правило, принимающие решения о покупках, и эксплуатирующие потом купленную аппаратуру - это разные люди. Человеку, читающему РЭ, совсем не интересно знать, какие там еще продукты предлагает наша компания, пусть даже они очень хорошие...

comment:23 by san, 7 years ago

ок, значит по самой главе Мониторинг возражений нет, спор только о включении туда пункта Supervisor

comment:24 by andrei, 7 years ago

Пока оставляем, напротив супервизора ставлю вопрос.

comment:25 by san, 7 years ago

Cc: viktam artem added

comment:26 by andrei, 7 years ago

Убрал платы питания из общего описания.
Плату SW оставлю, без нее блок все равно проживет не долго и неполноценно.

comment:27 by san, 7 years ago

milestone: Текущие работы2 очередь

Milestone renamed

comment:28 by andrei, 7 years ago

Cc: Vladimir added

comment:29 by san, 7 years ago

Owner: changed from andrei to Vladimir
Status: newassigned

comment:30 by san, 6 years ago

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

comment:31 by andrei, 6 years ago

Resolution: не будем делать
Status: assignedclosed

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

comment:32 by san, 23 months ago

milestone: 2 очередь

Milestone deleted

Note: See TracTickets for help on using tickets.