Несколько советов, как повысить читабельность технического текста:
- Добавить краткое описание. 1 Это поможет подавать информацию от общего к частному и облегчит понимание текста. 1
- Добавить заголовки и подзаголовки. 15 Они упростят ориентирование по тексту и создадут ощущение порядка. 1
- Перевести на язык читателя. 1 Если в тексте есть прямая речь заказчика с его терминами и оборотами, стоит рассказать, что эти слова значат применительно к системе. 1
- Убрать лишнее описание текущей функциональности. 1 Логично упоминать только то, что затрагивается новой функциональностью или влияет на её разработку. 1
- Использовать простые обороты. 1 Если предложение получается чересчур официальным, стоит попробовать пересказать его по памяти своими словами — так пересказ будет проще. 1
- Прочитать текст вслух. 3 Это поможет выявить шероховатости и неточности. 3
- Обратить внимание на размер шрифта и межстрочный интервал. 3 Стоит выбирать такой размер шрифта, чтобы в строке помещалось около 10 слов, а расстояние между строками установить в 120–140% от размера шрифта. 3