Некоторые основные ошибки, которые допускают при написании технической документации:
- Неуместная подача информации. 1 Фраза «кому надо, тот поймёт» не способствует чистоте и ясности текста. 1
- Избыточное использование профессионального жаргона и англицизмов. 1 Их нужно сверять со словарями и действующими нормами. 1
- Применение оборотов, которые не соответствуют стилю документации. 1 Например, «осуществляет установку», «следует воспользоваться», «обеспечьте выполнение». 1
- Нечёткая формулировка. 3 Для документа лучше использовать более чёткие высказывания: день, момент. 3
- Несоблюдение правил редакционно-издательского оформления. 2 В технической документации должны быть соблюдены все правила, например, где ставить точку, точку с запятой. 2
Чтобы избежать ошибок, при написании технической документации рекомендуется подбирать простые слова и конструкции, а также придерживаться выбранного написания везде. 1