[Перевод] Как написать грамотный гайд: правила для техписов и разрабов

Большинство гайдов по программному обеспечению написаны трагически плохо. В них не хватает важной информации, и это мешает пользователям повторить описанные в руководстве процессы. Иногда автор исходит из скрытых предпосылок, которые не соответствуют ожиданиям читателя. Но есть и хорошая новость: научиться писать грамотные руководства проще, чем вы думаете. Следуйте нескольким простым правилам, и ваши тексты будут выделяться на фоне повсеместной посредственности. Прочитать →

https://habr.com/ru/companies/netologyru/articles/873674/

#гайд #руководство #техпис #технический_писатель #техническая_документация #технические_тексты #технический_гайд #формулировка #хорошие_примеры #как_надо_писать