{"canonical_url":"https://engineer.company/uk/portfolio/put-the-documentation-under-its-own-linter/","content_markdown":"# Підключила до документації окремий лінтер\n\nПідключила до документації окремий лінтер — ліміт рядків для кожного файлу, який можна лише знижувати, вимогу індексу та перевірку справжніх шляхів, — який знайшов шість із дев'яти планів, позначених виконаними, попри невідмічені пункти, і чотирнадцять завдань перевірки перед комітом, не згаданих у жодному документі.\n\nсерпень 2026\n\n**Ситуація.** Репозиторій живе за власними письмовими інструкціями — двадцятьма шістьма документами про політику якості, дизайн‑систему, доступність, друк, метадані, переклад і git. Інструкції старіють за характерним сценарієм: вони довшають, розходяться з кодом, починають посилатися на файли, які вже перемістили, а після певного обсягу їх перестають читати. Непрочитане правило — не правило.\n\n**Завдання.** До документації треба було ставитися так само, як до коду, — тобто потрібен був лінтер з обмеженнями, які блокують, а не просто радять.\n\n**Дія.** Вісім політик, і кожна перевіряється механічно. Жорстка межа довжини документа й м'якша, яка лише попереджає. Бюджет рядків для кожного файлу, який може лише зменшуватися, тож документ може скоротитися, але вже не виросте назад. Обов'язковий покажчик для документів, довших за певний поріг, і покажчик розділів — для довших за менший поріг. Правило розташування: яка тема належить якому документу. Справність посилань. Чесність планів: заявлений у плані статус має відповідати його власним прапорцям. Правило, за яким кожне завдання, що перевіряє коміт, має бути згадане в якомусь документі. І перевірка реальних шляхів: кожен шлях із зазначенням каталогу й кожен символ коду, згаданий у документі, мають справді існувати. Перший же запуск виправдав усю затію: шість планів, позначених як виконані, з невідміченими прапорцями, чотирнадцять завдань, які перевіряли кожен коміт, але не згадувалися в жодному документі, три биті посилання, один документ, на який ніщо не посилалося, і три шляхи в нікуди в п'яти документах. Згодом бюджет не пропустив навіть зміну від того, хто його запровадив: підсумок цієї роботи, дописаний до документа про розробку, вивів той за межу, — так і з'явився окремий документ, тобто політика спрацювала саме так, як задумано.\n\n**Результат.** Двадцять шість документів загальним обсягом приблизно 2 666 змістовних рядків, кожен у межах бюджету, який не може зрости, а кожен згаданий у них шлях і символ звірено з деревом репозиторію. Незручний висновок варто повторити: чотирнадцять перевірок контролювали кожен коміт, але не згадувалися в жодному документі, тож правила, які застосовувала машина, і правила, які читали люди, вже розійшлися.\n\n---\n\n- Роль: Технічний продакт‑менеджер\n- Категорії: [Автоматизація та CI/CD](https://advisory.engineer.company/uk/categories/automation/), [Тестування та QA](https://advisory.engineer.company/uk/categories/testing/), [Python](https://advisory.engineer.company/uk/categories/python/), [Технічне лідерство](https://advisory.engineer.company/uk/categories/technical-leadership/), [Управління проєктами](https://advisory.engineer.company/uk/categories/project-management/), [Документація](https://advisory.engineer.company/uk/categories/documentation/)\n- Послуги: [Технічне лідерство та консалтинг](https://advisory.engineer.company/uk/services/technical-leadership/), [Управління проєктами (Agile)](https://advisory.engineer.company/uk/services/project-management/), [Технічна документація](https://advisory.engineer.company/uk/services/technical-documentation/)\n\n\u003chttps://engineer.company/uk/portfolio/put-the-documentation-under-its-own-linter/\u003e\n","date_modified":"2026-11-08T02:20:12Z","description":"Двадцять шість документів загальним обсягом приблизно 2 666 змістовних рядків, кожен у межах бюджету, який не може зрости, а кожен згаданий у них шлях і…","formats":{"gemtext":"https://advisory.engineer.company/uk/portfolio/put-the-documentation-under-its-own-linter/index.gmi","gopher":"https://advisory.engineer.company/uk/portfolio/put-the-documentation-under-its-own-linter/gophermap","html":"https://advisory.engineer.company/uk/portfolio/put-the-documentation-under-its-own-linter/","json":"https://advisory.engineer.company/uk/portfolio/put-the-documentation-under-its-own-linter/index.json","markdown":"https://advisory.engineer.company/uk/portfolio/put-the-documentation-under-its-own-linter/index.md","pdf":"https://advisory.engineer.company/uk/portfolio/put-the-documentation-under-its-own-linter/index.pdf"},"kind":"page","language":"uk","title":"Підключила до документації окремий лінтер","url":"https://advisory.engineer.company/uk/portfolio/put-the-documentation-under-its-own-linter/","version":1}