Руководитель говорит, что краткая документация не смотрится солидно

Здравствуйте, Максим! На работе я пишу документацию для игр. По ней работают разработчики, и она уходит заказчику. Я стараюсь писать ёмко, использовать схемы, так как большой текст никто не читает и это приводит к проблемам в разработке. При этом руководитель говорит, что краткая документация не смотрится солидно, в том числе для заказчика — те, мол, люди старой школы и любят большие документы. Как быть? Продолжать создавать документы, по которым удобно работать, и надеяться, что люди старой школы поймут их функциональность?

Сделайте две версии. Или одну версию, где сначала всё основное со схемами и ёмко, а потом подробно и толстенько.

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

Как создать видимость, не тратя много времени:

  • Наймите недорогого помощника, чтобы он расписывал всё подробно и формально.

  • Повысьте размер шрифта и межстрочный интервал.

  • Добавляйте стандартные блоки типа общих принципов разработки.

  • Расширяйте каждый тезис документации с помощью нейросетей.

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

Текст, редактура и информационный стиль
Отправить
Поделиться
Запинить

Комментариев пока нет

Рекомендуем другие советы