Мой ответ на пост
Anna Я считаю, что хороший TW должен априори уметь пользоваться семантическими языками разметки, гитом, иметь джунские навыки во фронте и т.п..
Развитие TW должно основываться не просто на написание доков в ворде по ГОСТ, а на современных подходах к разработке кода (именно кода, т.к. код и контент должны быть взаимосвязаны), да к life cycle разработки ПО в том числе.
Понятно, что документация на программу должна быть неотъемлемой частью как и кода, так и продукта, и документация в отрыве от процессов разработки, выполненная, например, в ворде, безусловна не является идеалом, точнее, стремлением к идеалу для техписа.
Кто такой TW в компании, которая выпускает код как продукт?
По мне, это человек, который замыкает на себе как раз многие процессы в данной компании. Должен замыкать. И плохо когда технический писатель со своей документацией остаётся в стороне от процессов. Почему плохо?
- Полнота. Если TW не коммуницирует с командами ,если не добывает сведения, то продукт в документации не будет описан полно. А для этого надо уметь/хотеть быть частью команды, в том числе и выполнять роль менеджера, если придётся
- Обновление. нет ничего хуже, если меняется какая-либо функциональность продукта, а документация не обновлена. Плохо, если сие действие влияет критически (пример - документация на полётный блок ПО в Боингах). А значит надо снова ходить, общаться, понимать и знать источники информации. Знать и roadmap по продукту компании.
- Доступность. Если документация содержится локально на компе TW, значит её, документации, нет совсем. Если документация лежит в word и эти ворд-доки множатся через re:re1:re2, значит этой документации нет. А значит техническому писателю надо уметь делать так, чтобы любой сотрудник компании могу получить доступ к одной и той же версии документа в любой момент. Значит техпис должен знать простейшие механизмы соответствующих технологий, чтобы смочь.
- Правдивость. Нет ничего хуже, когда документация написана неправильно. Когда неправильно описаны классы, библиотеки, шаги, действия, параметры и т.д. Ужасно, когда последовательность шагов по установке программы или настройке этой же самой программы, написаны с ошибками, которые не не приведут к success. А значит TW надо разбираться в продукте, в технологиях, на которых разрабатывается эта программа. Не падать в обморок от чистого кода.
——
А для этого, техпису надо расти.