Команда, в которой я сейчас работаю, испытывает довольно высокую текучесть кадров, члены которой обычно переходят на разные проекты в рамках одной компании. В настоящее время наша «тренировка» для новых участников состоит в том, чтобы соединить их с основным контактом (обычно самым последним, кто завершит их обучение), который предоставит им практический опыт и попросит более старших разработчиков, если новый новичок спросит что-то у наставника. не знает Это дает возможность новому наемнику быстро принять участие и бросает вызов наставнику, чтобы улучшить его / ее понимание системы.
Однако, как вы можете себе представить, этот стиль обучения занимает очень много времени и не обеспечивает очень хорошую передачу знаний (распространяются неправильные представления, расширяются пробелы).
Мне было поручено создавать документацию и учебные материалы для наших будущих новых сотрудников. Я уже время от времени делаю технические записи, но они предназначены для конечного пользователя и очень специфичны, содержат множество скриншотов и занимают много времени.
Создание новой документации для новых сотрудников считается низким приоритетом, и сейчас у меня есть ~ 40 часов, чтобы поработать над этим. Документирование системы текущим способом, которым я пишу техническую документацию, едва бы поцарапало поверхность за 40 часов. Особенно учитывая, что я должен документировать не только о кодовой базе, но и о развертывании и поддержке.
Как я могу быстро написать документацию, чтобы как можно быстрее получать новых сотрудников, не тратя значительное время на написание документации?
Дополнительная информация:
В настоящее время у нас есть и вики, и некоторая учебная документация, однако обе они довольно редки.