Opened 4 months ago

Closed 3 months ago

Last modified 3 months ago

#1318 closed дефект (готово)

РЭ: непонятная фраза в тексте

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

Description

В РЭ аппаратуры MC04-DSL-3U редакции 62 в разделе 5.15.1 на странице 108 есть такая фраза:

Сменные оптические модули 155 Мбит/с:

и далее следует перечисление трех модулей. В этом фразе нет сказуемого (что сменные оптические модули делают?), поэтому ее смысл в тексте РЭ мне непонятен.

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

Change History (8)

in reply to:  description ; comment:1 by Vladimir, 3 months ago

Resolution: готово
Status: newclosed

Replying to alx:

В РЭ аппаратуры MC04-DSL-3U редакции 62 в разделе 5.15.1 на странице 108 есть такая фраза:

Сменные оптические модули 155 Мбит/с:

и далее следует перечисление трех модулей. В этом фразе нет сказуемого (что сменные оптические модули делают?), поэтому ее смысл в тексте РЭ мне непонятен.

Это Заголовок, а в заголовке достаточно указать только подлежащее, например, "5.15 Плата 4C-37",
а на рисунке показаны слоты для этих модулей.

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

А для непонятливых я добавил слова:
"Сменные оптические модули SFP 155 Мбит/с для установки в плату 4C-37:" хотя это и так само-собой разумеется :-)

in reply to:  1 ; comment:2 by alx, 3 months ago

Replying to Vladimir:

Это Заголовок,

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

а на рисунке показаны слоты для этих модулей.

При рисунок в описании тикета не говорится ни слова.

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

in reply to:  2 ; comment:3 by Vladimir, 3 months ago

Replying to alx:

Replying to Vladimir:

Это Заголовок,

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

Двоеточие уже удалил, хотя это несущественно и на понимание не влияет :-)

а на рисунке показаны слоты для этих модулей.

При рисунок в описании тикета не говорится ни слова.

Потому, что рисунок не где-то далеко, а на этой же странице и любой юзер начнёт читать
сверху вниз, поэтому про SFP он уже будет знать :-)

in reply to:  3 ; comment:4 by alx, 3 months ago

Replying to Vladimir:

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

Двоеточие уже удалил,

В РЭ-62, на которое я "жаловался" в описании тикета, двоеточие есть - я совершенно ясно его вижу.

хотя это несущественно и на понимание не влияет :-)

Как видишь, повлияло - я, читая РЭ, не понял, что "Сменные оптические модули 155 Мбит/с:" - это заголовок нового раздела.

а на рисунке показаны слоты для этих модулей.

При рисунок в описании тикета не говорится ни слова.

Потому, что рисунок не где-то далеко, а на этой же странице и любой юзер начнёт читать
сверху вниз, поэтому про SFP он уже будет знать :-)

Нет, не поэтому. Про рисунок в описании тикета не сказано ни слова, потому что дефект, о котором я тебе сообщил в описании тикета, не имеет отношения к рисунку.

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

in reply to:  4 ; comment:5 by Vladimir, 3 months ago

Replying to alx:

Replying to Vladimir:

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

Двоеточие уже удалил,

В РЭ-62, на которое я "жаловался" в описании тикета, двоеточие есть - я совершенно ясно его вижу.

Ну это же естественно и само-собой, что изменить РЭ я могу и сделал это только
в редактируемой и неопубликованной ещё редакции РЭ-64 от сего дня!
Ты даже это не понял? :-)

Как видишь, повлияло - я, читая РЭ, не понял, что "Сменные оптические модули 155 Мбит/с:" - это заголовок раздела.

Ну, ты уж слишком внимательный и придирчивый даже к пустяковым мелочам :-)
Это называется "перфекционизм". Яндекс нашёл быстрый ответ:
"Говоря простыми словами, перфекционизм — это стремление человека делать все идеально, совершенно, причем везде и всегда. Человек — перфекционист очень много на себя возлагает и, безусловно, испытывает дискомфорт, когда что-то идет не по плану. Перфекционист и от своего окружения может требовать большего и, зачастую перегибать палку, в погоне за той самой идеальной картинкой." :-)
Я тоже часто стремился быть перфекционистом, но у тебя это лучше получается! Даже завидую! :-)

а на рисунке показаны слоты для этих модулей.

При рисунок в описании тикета не говорится ни слова.

Потому, что рисунок не где-то далеко, а на этой же странице и любой юзер начнёт читать
сверху вниз, поэтому про SFP он уже будет знать :-)

Нет, не поэтому. Про рисунок в описании тикета не сказано ни слова, потому что дефект, о котором я тебе сообщил в описании тикета, не имеет отношения к рисунку.

Тогда текст заголовка "Сменные оптические модули SFP 155 Мбит/с для установки в плату 4C-37"
по твоему соответствует содержанию дальнейшего текста?
Может быть ты можешь улучшить этот заголовок, чтобы он был идеальный?

in reply to:  5 ; comment:6 by alx, 3 months ago

Replying to Vladimir:

В РЭ-62, на которое я "жаловался" в описании тикета, двоеточие есть - я совершенно ясно его вижу.

Ну это же естественно и само-собой, что изменить РЭ я могу и сделал это только
в редактируемой и неопубликованной ещё редакции РЭ-64 от сего дня!

Это, конечно, естественно и само собой, но какое это имеет отношение к тому, что я написал в описании тикета? В описании тикета, как мне казалось, ясно указано, что фраза, о которой я пишу, находится в РЭ редакции 62. Странно, что ты это не понял... :)

Ты даже это не понял? :-)

Я, действительно, не понял, зачем писать о том, что в какой-то другой редакции РЭ ты двоеточие убрал, если в этом тикете совершенно (как мне казалось до этого момента) ясно и отчетливо сказано, что речь идет о написанном в РЭ редакции 62, а не какой-либо другой...

Яндекс нашёл быстрый ответ:

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

Тогда текст заголовка "Сменные оптические модули SFP 155 Мбит/с для установки в плату 4C-37"
по твоему соответствует содержанию дальнейшего текста?

Затрудняюсь ответить. Если "Сменные оптические модули SFP 155 Мбит/с для установки в плату 4C-37:" - это заголовок нового раздела, то смысл этого раздела мне непонятен. Он состоит из трех назывных предложений - "Модуль 2FS", "Модуль 2FL", "Модуль 2FV" (и ни у одного из них нет даже точки в конце!).
Ну, допустим, есть такие модули - и что? Зачем это здесь написано? Какое это имеет отношение к плате 4C-37? Непонятно...

Может быть ты можешь улучшить этот заголовок, чтобы он был идеальный?

Думаю, что могу. Во-первых, я бы в начале заголовка поставил номер раздела (5.15.2 получается). Во-вторых, я бы убрал двоеточие в конце - оно там ни к чему. В-третьих, если предположить (вот опять ты заставляешь меня гадать!), что в скобках указаны характеристики модулей (и в этом и состоит смысл раздела), я бы дал раздену название "5.15.2 Некоторые характеристики некоторых оптических модулей SFP" (указывать в заголовке 155 Мбит/с не вижу смысла, так как в самом разделе это и так написано в каждом предложении). Станет ли после этого заголовок идеальным, я не знаю, но лучше по-моему определенно станет...

in reply to:  6 ; comment:7 by Vladimir, 3 months ago

Replying to alx:

Replying to Vladimir:

Тогда текст заголовка "Сменные оптические модули SFP 155 Мбит/с для установки в плату 4C-37" по твоему соответствует содержанию дальнейшего текста?

Затрудняюсь ответить. Если "Сменные оптические модули SFP 155 Мбит/с для установки в плату 4C-37:" - это заголовок нового раздела

Нет это просто в п."5.15.1 Конструкция платы 4C-37" небольшой подзаголовок,
который необязательно обозначать цифрами - в РЭ много подобных подзаголовков.
В п.5.15.1 идёт описание конструкции, которая позволяет устанавливать некие модули
и перечень этих, поставляемых АДС совместимых с платой модулей указан в подзаголовке.

то смысл этого раздела мне непонятен. Он состоит из трех назывных предложений - "Модуль 2FS", "Модуль 2FL", "Модуль 2FV" (и ни у одного из них нет даже точки в конце!).
Ну, допустим, есть такие модули - и что? Зачем это здесь написано? Какое это имеет отношение к плате 4C-37?

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

Может быть ты можешь улучшить этот заголовок, чтобы он был идеальный?

Думаю, что могу. Во-первых, я бы в начале заголовка поставил номер раздела (5.15.2).

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

Во-вторых, я бы убрал двоеточие в конце - оно там ни к чему.

В редактируемом РЭ-64 двоеточия уже нет, а точки в перечислении поставлены.

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

Это не раздел, а перечисление, а краткий текст в скобках взят из Прайса АДС
(а также обозначен на СОС, есть в Спецификации, коммерческом предложении) и уточняет
разновидность модуля - какой попало модуль ставить нельзя.

я бы дал раздену название "5.15.2 Некоторые характеристики некоторых оптических модулей SFP" (указывать в заголовке 155 Мбит/с не вижу смысла, так как в самом разделе это и так написано в каждом предложении).

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

Станет ли после этого заголовок идеальным, я не знаю, но лучше по-моему определенно станет...

Шкляр любил говорить: "Лучшее - враг хорошего!" :-)

in reply to:  7 comment:8 by alx, 3 months ago

Replying to Vladimir:

Ну, допустим, есть такие модули - и что? Зачем это здесь написано? Какое это имеет отношение к плате 4C-37?

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

Во-первых, откуда ты можешь знать, какие модули применяются? :) Это же зависит не от тебя, а от пользователя. У пользователя нет обязанности уведомлять тебя о том, какой модуль он в плату установил. :)

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

Смысл этого подраздела мне по-прежнему непонятен...

Может быть ты можешь улучшить этот заголовок, чтобы он был идеальный?

Думаю, что могу. Во-первых, я бы в начале заголовка поставил номер раздела (5.15.2).

Это совсем не обязательно

Ты спросил, могу ли я улучшить - я тебе ответил, как по моему мнению было бы лучше.

Во-вторых, я бы убрал двоеточие в конце - оно там ни к чему.

В редактируемом РЭ-64 двоеточия уже нет, а точки в перечислении поставлены.

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

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

Это не раздел,

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

а перечисление,

Хм... А разве у тебя в РЭ каждое перечисление имеет заголовок? Нет, далеко не каждое. А это имеет. Значит это не просто перечисление, а что-то большее...

а краткий текст в скобках взят из Прайса АДС

Какое это имеет значение для читателя РЭ?

(а также обозначен на СОС,

??? Какой СОС? Какое отношение какая-то СОС имеет к данному тикету? Я в описании тикета ни про какую СОС ничего не писал. Я писал о РЭ аппаратуры MC04-DSL-3U редакции 62...

есть в Спецификации,

??? Какой спецификации? Какое отношение какая-то спецификация имеет к данному тикету? Я в описании тикета ни про какую спецификацию ничего не писал. Я писал о РЭ аппаратуры MC04-DSL-3U редакции 62...

коммерческом предложении

??? Каком коммерческом предложении? Какое отношение какое-то коммерческое предложение имеет к данному тикету? Я никакого комерческого предложения не получал и в описании тикета ни про какое коммерческое предложение ничего не писал. Я писал о РЭ аппаратуры MC04-DSL-3U редакции 62...

и уточняет разновидность модуля - какой попало модуль ставить нельзя.

Подожди, я что-то не понимаю... Ты говоришь, что в этом разделе (или, как ты утверждаешь, не разделе) указано, какие модули можно ставить в плату 4C-37? Если да, то я этого там не вижу. Не хочешь же ты сказать, что из всего великого многообразия существующих в природе модулей в этой плате могут работать только три перечисленные? :)

я бы дал раздену название "5.15.2 Некоторые характеристики некоторых оптических модулей SFP" (указывать в заголовке 155 Мбит/с не вижу смысла, так как в самом разделе это и так написано в каждом предложении).

Эта одна цифра -

Нет. Это три цифры. :)

даже и не характеристика, а скорее рекомендация,

Каким же образом читатель, по твоей задумке, должен догадаться, что ему рекомендуется использовать модули на скорость 155 Мбит/с, если в тексте об этом не говорится? Я вот не догадался...

Да и слово "некоторые" по отношению к одной

В заголовке, приведенном мной в comment:6, нет слова "некоторые", относящегося к одной. Там есть слово "Некоторые", относящееся к двум (характеристикам), и есть слово "некоторым", относящееся к трем (модулям).

для подзаголовка как-то плохо звучит :-)

Я сделал все что мог.

В реальности расстояние может быть как больше, так и меньше указанной цифры...

Как странно... Если расстояние может быть больше указанной цифры, зачем тогда указывать расстояние "до" и ставить цифры? :) Чтобы никто ничего не понял (как я)? :)

Станет ли после этого заголовок идеальным, я не знаю, но лучше по-моему определенно станет...

Шкляр любил говорить: "Лучшее - враг хорошего!" :-)

Я же не по своей инициативе это написал, ты сам меня об этом просил! "Не нравится - не ешь", как ответили студенту, которому не нравился декан... :)

Version 4, edited 3 months ago by alx (previous) (next) (diff)
Note: See TracTickets for help on using tickets.