# Написала 50 000 слів вичерпної документації програмного забезпечення, використовуючи Markdown у GitHub, Craft та Confluence, забезпечивши збереження знань і прозорість процесу.

2022 – 2024

**Ситуація.** Майже все важливе про продукт і роботу команди існувало лише в головах людей. Так можна жити, аж поки не прийде новачок або хтось не звільниться, — і тоді онбординг ледве повзе, а частину інституційної пам'яті від зникнення назавжди відділяє одна заява про звільнення.

**Завдання.** Мета полягала в тому, щоб перенести ці знання з голів у документацію, яку люди справді вели б і використовували: достатньо зрозумілу, щоб її читали, і достатньо структуровану, щоб її підтримували в актуальному стані, а не закидали через місяць.

**Дія.** Значну частину написано вручну — під кінець набралося близько 50 000 слів — у Markdown, у GitHub, Craft і Confluence, залежно від того, де місце кожному фрагменту. Документація охоплювала архітектуру, процеси й практичні інструкції — відповіді на запитання, які люди ставили знову і знову. Її тримали під контролем версій і, що не менш важливо, так, щоб її було легко знайти, адже документація, якої ніхто не може знайти, нічим не краща за відсутню.

**Результат.** Знання перестали бути крихкими. Новачки швидше входили в курс справ, на процес тепер можна було послатися, а не відтворювати його з пам'яті, а вся робота стала придатною до аудиту: було видно, як і чому її виконували, і не доводилося вірити на слово.

---

- Роль: Product Owner і менеджер з розвитку проєктів
- Категорії: [Керівництво командою](https://advisory.engineer.company/uk/categories/team-leadership/), [Технічне лідерство](https://advisory.engineer.company/uk/categories/technical-leadership/), [Менторство та коучинг](https://advisory.engineer.company/uk/categories/mentoring/), [Документація](https://advisory.engineer.company/uk/categories/documentation/)
- Послуги: [Технічне лідерство та консалтинг](https://advisory.engineer.company/uk/services/technical-leadership/), [Технічна документація](https://advisory.engineer.company/uk/services/technical-documentation/)

<https://advisory.engineer.company/uk/portfolio/wrote-50-000-words-of-comprehensive-software-documentation-30/>
