Команда, в якій я зараз є частиною досвіду досить високого обороту, учасники зазвичай переходять до різних проектів в одній компанії. В даний час наше "навчання" для нових членів полягає в поєднанні їх з основним контактом (як правило, найсвіжіша людина, яка завершить навчання), яка надасть їм практичний досвід і попросить більше старших розробників, якщо нові наймачі запитають щось у наставника не знає. Це дає шанс новому найманому працеві швидко долучитися до роботи та викличе наставнику також покращити його розуміння системи.
Однак, як ви можете собі уявити, такий стиль навчання дуже трудомісткий і не забезпечує дуже хорошого перенесення знань (помилкові уявлення поширюються, розриви розширюються).
Мені доручено створити документацію та навчальні матеріали для наших нових майбутніх найм. Я вже займаюся технічним написанням періодично, але це для кінцевого користувача і є дуже специфічним з великою кількістю скріншотів і вимагає великої кількості часу для його завершення.
Створення нової документації для нових наймань вважається низьким пріоритетом, і я працюю над цим лише 40 годин. Документування системи поточним способом, як я пишу технічну документацію, ледь не подряпає поверхню за 40 годин. Особливо враховуючи, що мені доведеться документувати не лише про базу коду, але й про розгортання та підтримку.
Як я можу швидко написати документацію, щоб якнайшвидше оновлювати нові роботи, не вкладаючи значних витрат часу на написання документації?
Додаткова інформація: На
даний момент у нас є і вікі, і деяка навчальна документація, однак обидві є рідкісними.