В нашей компании технический писатель должен обладать такими компетенциями как: умение собирать информацию необходимую для работы, умение писать документы отвечающие требованиям ГОСТ серии 19 и 34, умение работать в команде, а также обладать знаниями процесса и методологий разработки программного обеспечения, его тестирования, описания бизнес-процессов и функциональных требований, структуры данных, дизайна экранных форм.
Задача статьи как раз была в том, чтобы показать, что на самом деле стоит за написанием технической документации, и что это не так просто как кажется, поэтому этим должен заниматься специально обученный человек.
Профильные специалисты вполне могут в рамках своих компетенций заполнить соответствующие разделы проектно-эксплуатационной документации. И возможно смогут собрать все разделы в один документ. Но у нас в компании за это отвечает технический писатель.
К сожалению, пример показать не можем, так как у нас существует соглашение о неразглашении, но в качестве примера можно привести один из самых часто составляемых документов — ФТ. Что это такое и как его составлять, можно почитать тут: habr.com/ru/company/retailrocket/blog/431572
В этом состоит одна из задач технического писателя, чтобы разузнать все составляющие системы и логику взаимодействия между ними у тех членов команды, которые обладают этими знаниями и задокументировать это.
Задача статьи как раз была в том, чтобы показать, что на самом деле стоит за написанием технической документации, и что это не так просто как кажется, поэтому этим должен заниматься специально обученный человек.
Профильные специалисты вполне могут в рамках своих компетенций заполнить соответствующие разделы проектно-эксплуатационной документации. И возможно смогут собрать все разделы в один документ. Но у нас в компании за это отвечает технический писатель.
habr.com/ru/company/retailrocket/blog/431572