Колеги, хто працює з внутрішньою технічною документацією в компанії, розкажіть, будь ласка, чи є ваша документація частиною процесу розробки чи існує сама по собі? Наприклад, чи створюється вона під час розробки нової фічі, одразу після релізу на прод чи вже задовго після? Хто ініціює процес написання тієї чи іншої статті: тех райтер чи розробник? Чи є структурований флоу того, як нова стаття з'являється у внутрішній базі знань? Чи існують якісь дієві методи зробити документацію частиною процесу розробки в компанії? І чи існують дієві методи залучення розробників, тестувальників, девопсів до створення документації в процесі розробки?
top of page
bottom of page
дуже мачурне питання)
Довгий час у нас було все на совісті інженерів. Я як техрайтерка була відкрита до колаборації і допомоги, якщо хтось її потребував.
Нещодавно наша компанія прописала детальний Feature Development Life Cycle, який складається з 6 етапів. На 4 етапі Implementation and QA є required степи, які доки потрібно апдейтити і такий optional степ: Update all other docs that related to implemented changes. Тобто віднедавна стало чітко зрозуміло коли потрібно писати доки і хто відповідальний. Але чи буде це працювати на практиці — побачимо:)
Дієвий метод: щоб керівництво виписало чарівний пендель розробникам, які не залишають ніякої документації під час розробки фічи або немає практики залишати коментарі в самому коді. З цих коментарів можна генерувати хтмл документацію за допомогою різних тулів, як-от javadoc: https://www.softwaretestinghelp.com/javadoc-tool/