Size: a a a

2019 August 14

КБ

Кирилл Богатов in technicalwriters
Angela
у вас какой формат справки? если финальный html, то гораздо удобнее запилить движок версионности с выбором версии справки и продукта на каждой странице и соответствующим контентом
Мы используем MediaWiki
источник

КБ

Кирилл Богатов in technicalwriters
Stas Rychkov
А это единственная такая статья, где разное поведение в зависимости от версий? Отдельные разделы нет смысла делать?
Если версии отличаются сильно, то мы делаем отдельные статьи. Но тут изменений не так много
источник

JM

Jaroslaw Martinow in technicalwriters
Я бы добавил подзаголовки:

<h4>Процесс разнесения в таких-то версиях</h4>

<h4>Процесс разнесения в такой-то версии</h4>
источник

JM

Jaroslaw Martinow in technicalwriters
Может быть, окончание можно отделить горизонтальной линией </hr>, как вариант.
источник

SR

Stas Rychkov in technicalwriters
Jaroslaw Martinow
Я бы добавил подзаголовки:

<h4>Процесс разнесения в таких-то версиях</h4>

<h4>Процесс разнесения в такой-то версии</h4>
👍
источник

NV

Nick Volynkin in technicalwriters
Кирилл Богатов
Всем привет. Такой кейс. В одной статье идёт описание сразу для нескольких версий ПО. При этом получается такая структура: общий текст - текст для версии 1 - текст для версии 2 - общий текст. В итоге становится непонятно, относится ли текст ко всем версиям, или только к версии 2. Пустые строки и полосы пробовал, смотрятся плохо. Можно ли как-нибудь красиво выкрутиться здесь?
Можно выделить блок текста про конкретную версию вертикальной чертой слева и отступом. Кончилась черта и отступ — кончился блок про версию, сразу понятно.
источник

NV

Nick Volynkin in technicalwriters
Кирилл Богатов
Всем привет. Такой кейс. В одной статье идёт описание сразу для нескольких версий ПО. При этом получается такая структура: общий текст - текст для версии 1 - текст для версии 2 - общий текст. В итоге становится непонятно, относится ли текст ко всем версиям, или только к версии 2. Пустые строки и полосы пробовал, смотрятся плохо. Можно ли как-нибудь красиво выкрутиться здесь?
В HTML это будет так: нужный текст обернут в div со стилем вроде border-left: solid 5px. Тут есть пример: https://www.w3schools.com/howto/howto_css_vertical_line.asp
источник

NV

Nick Volynkin in technicalwriters
Ещё вариант — раскрываемый блок
источник

NV

Nick Volynkin in technicalwriters
И ещё один — блок с табами по версиям. В идеале так чтобы один раз выбрать таб нужной версии и все подобные блоки переключились на эту версию.

Так и текста на экране будет меньше.
источник

КБ

Кирилл Богатов in technicalwriters
Nick Volynkin
И ещё один — блок с табами по версиям. В идеале так чтобы один раз выбрать таб нужной версии и все подобные блоки переключились на эту версию.

Так и текста на экране будет меньше.
МедиаВики так не умеет. А идея хороша
источник

КБ

Кирилл Богатов in technicalwriters
Сделал блоками. Как вам?
источник

MS

Maria Shabanova in technicalwriters
Как-то не очень)
источник

MS

Maria Shabanova in technicalwriters
По ощущениям это относится к тому же, к чему относится первый блок "Важно", из-за одинакового оформления. Как элементы списка
источник

AP

Anna P in technicalwriters
Nick Volynkin
И ещё один — блок с табами по версиям. В идеале так чтобы один раз выбрать таб нужной версии и все подобные блоки переключились на эту версию.

Так и текста на экране будет меньше.
Вот тоже хотела предложить такой вариант. Это и с точки зрения навигации удобно—сразу можно читать только про нужную версию.
источник

КБ

Кирилл Богатов in technicalwriters
Anna P
Вот тоже хотела предложить такой вариант. Это и с точки зрения навигации удобно—сразу можно читать только про нужную версию.
Мы делаем так, но только если изменения серьезные, т.к. не можем многократно использовать одни и те же куски контента как в Dita.
источник

SR

Stas Rychkov in technicalwriters
Кирилл Богатов
Сделал блоками. Как вам?
А скрыть не хотите, оставив текущую версию на виду?
источник

КБ

Кирилл Богатов in technicalwriters
Stas Rychkov
А скрыть не хотите, оставив текущую версию на виду?
Не вариант. Разные клиенты используют разные версии.
источник

SR

Stas Rychkov in technicalwriters
Тогда для всех блоков.

<div class="opt" style="display:none;">Foo</div>
$("div.opt").show();

Останутся заголовки. Проще читать.
источник

КБ

Кирилл Богатов in technicalwriters
Stas Rychkov
Тогда для всех блоков.

<div class="opt" style="display:none;">Foo</div>
$("div.opt").show();

Останутся заголовки. Проще читать.
Тогда поиск по статье не будет работать.
источник

YD

Yuri Dobrev in technicalwriters
Кирилл Богатов
Не вариант. Разные клиенты используют разные версии.
так всё-таки один человек читает одну версию, зачем ему видеть другие версии?
источник