Size: a a a

Технические писатели

2021 July 29

SI

Sigurður Ingvarsson in Технические писатели
напридумывали понимаш
источник

SI

Sigurður Ingvarsson in Технические писатели
а русский человек мучайся
источник

с

суперагент гончик... in Технические писатели
источник

AD

Alyona Devon in Технические писатели
точно, спасибо!
источник

L

Lex in Технические писатели
наглядная иллюстрация того, чем отличается простой перевод от локализации ;)
источник

МБ

Мария Баюнова... in Технические писатели
привет. Подскажите, какое оформление вы используете для многоуровнего списка действий. А еще лучше если поделитесь источниками, где есть такое правило. Имею ввиду списки типа:
1. Нажмите на кнопку такую-то.
2. В открывшейся форме:
   - Включите тумблер.
   - Введите текст.
   - Нажмите то-то.
3. Нажмите еще то-то
источник

МБ

Мария Баюнова... in Технические писатели
Кажется, что буллеты подходят только, если не важна последовательность. В буквах непонятно использовать русские или латинские. Цифры типа 2.1. просто не нравятся)
источник

D

Demian in Технические писатели
Я бы сделал так:
1. Нажмите на кнопку такую-то. Откроется такая-то форма.
2. Включите тумблер.
3. Введите текст.
4. Нажмите то-то.
5. Нажмите еще то-то
источник

МБ

Мария Баюнова... in Технические писатели
да, это безусловно вариант. Но иногда есть необходимость все-таки использовать многоуровневый список
источник

rK

rJIynbIu` KOT in Технические писатели
всё так, как вы и написали в примере
источник

BF

Bobba Fett in Технические писатели
Я не использую, а избегаю (стараюсь изо всех сил). В вашем примере все эти подшаги можно сделать шагами первого уровня, без выделения в один шаг со своей когнитивной нагрузкой. Если же так получается, что иначе вообще не получается, то это указывает на почти гарантированную проблему с UX - нужно переделывать, потому что если вы даже описать это просто не можете, значит пользоваться этим точно чересчур сложно.
источник

OA

Olga Alexeeva in Технические писатели
привет) если дока по ГОСТу, то там все решено уже за нас
если по ГОСТУ 2.105-95, то список так выглядит (если память не изменяет:
a.
b.
  1.
  2.

если не по ГОСТу, то ваш вариант норм, кмк) буквы можно использовать любые, какие вам больше нравятся
источник

AD

Alyona Devon in Технические писатели
а что вы отвечаете, если вам на конкретные вопросы говорят — долго писать, давай по видео
(а ты прекрасно понимаешь что скорее всего там какие-то нюансы, будет долго рассказывать что-то далекое от твоего конкретного вопроса и нужно будет постоянно "возвращать". и в общем этот звонок обойдется тебе скажем в полчаса-час вместо минуты прочитать ответ и разойтись. молчу про то, что это придется записывать, потому что еще и не запомнишь и будешь все по несколько раз пересматривать)
источник

МБ

Мария Баюнова... in Технические писатели
когда список действий достаточно большой, сложно его воспринимать, если все на одном уровне. ИМХО
источник

BF

Bobba Fett in Технические писатели
Универсальных правил нет (речь же не про ГОСТ?), но вы очень логично отметили, что если последовательность не важна, то могут подойти буллеты, только вот они могут быть восприняты как “одно из этих действий”, а не “все действия в любой последовательности”.

Все варианты нумерации последовательных действий второго уровня имеют свои сложности для восприятия, имхо, можно выбрать любой, всё равно будет такое себе: заново нумеровать, использовать буквы или добавить уровень 2.1 2.2 и тд
источник

BF

Bobba Fett in Технические писатели
Когда список достаточно большой его сложно воспринимать в любом случае. Тут опять либо проблема с UX, либо вы запихнули в одну процедуру несколько, которые связаны, но всё же самостоятельны
источник

KP

K P in Технические писатели
Разбить на более мелкие процессы. Если обобщить пункты в отдельные процессы не получается, просто шаги:
Шаг 1. Укажите балабла
1. Это
2. Вот это
3. И это
Шаг 2. Настройте мелкий элемент
1. Откройте
2. Введите
3. Выберите
источник

BF

Bobba Fett in Технические писатели
Да, речь не про туториалы конечно, а когда это список шагов для выполнения одной конкретной задачи, а не наделать чего-то всякого разного, чтобы понять в процессе как оно работает. Туториалы конечно могут быть с десятками шагов и подуровнями
источник

정제니 in Технические писатели
Знаете, что такое "проклятие знанием"? Когда ты три недели делаешь одни и те же правки вручную, а тут бац - три клика и все будет на автомате... теперь... только теперь
источник

SR

Stas Rychkov in Технические писатели
Кажется, что это озарение, а не проклятие.
источник