Тут возник небольшой холивар по поводу порядка составления документации.

Дано: Есть некая сложная команда, которую нужно выполнить. И хочется дать пользователям возможность ознакомиться с подробным описанием каждого аргумента команды (зачем и почему оно нужно).

Вариант 1: Сначала пишем пример команды, чтобы скопипастить и выполнить (кому не интересно описание, а нужен результат). Затем уже пишем в табличном виде что зачем

Вариант 2: Сначала даем подробности каждого аргумента команды, и только затем даем пример команды.

Какой вариант лично вам ближе?

Опрос проводится в Telegram: https://t.me/vdsdblog/415

#опрос #голосование #холивар #документация #инструкция #удобство #ux