О работе технического писателя

С просторов интернета

Написание технической документации (если мы говорим именно об этом, а не о ТЗ) кропотливый процесс, который по стоимости гораздо дороже, чем само создание сайта/приложения.
Есть разные типы документации: для пользователей, для администраторов, для разработчиков, для Клавдии Васильевны и т.д. У фреймворка есть документация и она сгодится как документация для разработчиков. Но что конкретно требуется заказчику?
Для популярных cms документация создается годами у opensource, и иногда быстрее, но не качественнее у платных cms. По человекочасам/затратам, документация для пользователей может достигать стоимости маленькой банановой республики.
И тут либо :
- продукт сделан грамотно, интерфейсы просты и понятны 8 из 10 специалистам для которых создавался продукт. Она в принципе не нужна.
- не уделяли время, проектированию админки и не закладывали в стоимость, но интерфейсы решают задачи по ТЗ. Проще обучить или записать видео инструкцию по ключевым моментам.
- Об этом говорилось, что и как, но программист сделал по своему - косяк программера.

chesar

смотрите Материалы для технического писателя