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

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

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

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

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