Техническая документация — важная часть любого проекта: технические задания, функциональные спецификации, архитектурные документы, API references, инструкции по сборке, пользовательские мануалы...
Отношения с документацией у разработчиков обычно сложные. Читать хорошую документацию любят все, а вот писать ее (а тем более поддерживать в актуальном состоянии) довольно сложно. Многие считают, что документация на проекте может быть только в одном из двух состояний: либо ее вообще нет, либо она не радует.
На этом квартирнике мы поговорим о следующем:
-
Как можно улучшить ситуацию с документацией и нужно ли вообще этим заниматься? (ведь у многих получается жить вообще без нее)
-
Как сделать так, чтобы документация радовала? Можно ли формализовать критерии ее качества?
-
Кто должен заниматься написанием документации — инженеры в свободное время или специально выделенные для этого люди?
-
Насколько востребована профессия технического писателя? Готовы ли компании нанимать таких специалистов? Стоит ли выпускникам вузов идти в эту профессию?
-
Должен ли технический писатель уметь программировать?
Запись выступления:
