Послуги з технічного письма
Послуги з технічного письма для компаній, що розробляють програмне забезпечення: довідники API, посібники для розробників, документація для користувачів, операційні інструкції (runbooks) і примітки до релізу, які пишуться як код поряд із продуктом і оновлюються з кожним релізом.
Що роблять наші технічні письменники
Документація API
Довідник, що генерується зі схеми OpenAPI чи GraphQL, з посібниками для швидкого старту, покроковими інструкціями з автентифікації та прикладами, які можна запустити, написаними навколо нього, тож довідник ніколи не редагується вручну.
Документація як код
Документація в Markdown у вашому репозиторії, яку перевіряють у pull request так само, як код, і публікують за допомогою Docusaurus, Starlight чи схожого генератора тим самим пайплайном, що й продукт.
Посібники користувача та довідкові центри
Посібники за завданнями та статті довідкового центру, організовані за тим, що читач намагається зробити, і поділені на навчальні матеріали, практичні інструкції, довідники та пояснення за фреймворком Diátaxis.
Операційні інструкції та посібники з експлуатації
Покрокові процедури для розгортання, відновлення, реагування на інциденти та чергування (on-call), які перевіряє хтось, хто їх не писав.
Примітки до релізу та журнали змін
Примітки до релізу, що розповідають користувачам, що змінилося для них, і журнали змін для інтеграторів: чернетки складаються на основі вже влитих pull request і звіряються з релізом.
Перевірки стилю та якості
Гід зі стилю та перелік термінології, які автоматично перевіряє Vale у пайплайні, з перевіркою битих посилань під час кожної збірки, тож узгодженість не залежить від одного рецензента.
Наші технічні письменники для вашої команди
Повна зайнятість у вашій команді
Технічні письменники, які працюють у ваші години, у ваших інструментах і на ваших зустрічах і звітують вашому керівнику, а український договір, зарплата й відпустки на нашому боці.
Неповна або часткова зайнятість
Технічні письменники на визначену кількість днів на тиждень, коли робота вже є, але ще не на повну ставку.
Для проєкту чи запуску
Технічні письменники на визначений період роботи, від першого тижня до передачі, з датою завершення, погодженою заздалегідь.
На сторінці виділеної команди пояснено, як фахівці приєднуються до вашої команди, а на сторінці аутсорсингу описано реалізацію проєктів, прийняття систем від інших команд і те, як ми беремо оплату.
З ким працюють наші технічні письменники
Інженери та технічні лідери
Інтерв'ю, рев'ю та технічна точність
Менеджери продукту
Функції, аудиторії та обсяг релізу
Інженери підтримки
Питання, які користувачі справді ставлять
UI/UX-дизайнери
Тексти інтерфейсу та діаграми
Як працюють наші технічні письменники
Документація живе там, де код: у репозиторії, перевіряється в тому самому pull request, що й зміна, яку вона описує, а збирається і публікується пайплайном. Функція вважається готовою, коли її документацію влито, тож документація залишається такою ж актуальною, як і код.
Робота над текстом починається з читача: хто він, що намагається зробити і що вже знає. Тікети підтримки та пошукові запити показують, де чинна документація підводить, і ці сторінки виправляються першими.
Інші ролі, на які ми підбираємо фахівців
Проєктні менеджери
Управління проєктами розробки ПЗ: менеджери IT-проєктів і delivery-менеджери відповідають за плани, обсяг робіт, ризики, бюджети та щотижневу звітність. Працюють на повну зайнятість у вашій команді, на часткову або на один проєкт.
Бізнес-аналітики
Бізнес-аналіз для проєктів розробки ПЗ: обстеження, вимоги, user stories, карти процесів у BPMN і критерії приймання. Бізнес-аналітики працюють на повну зайнятість у вашій команді, на часткову або на проєкт.
Продакт-менеджери
Управління продуктом для програмних продуктів: продакт-менеджери та product owner для discovery, дорожніх карт, беклогів і продуктових метрик. На повну зайнятість у вашій команді, кілька днів на тиждень або на запуск.
Scrum-майстри
Scrum-майстри й agile-коучинг для команд розробки: Scrum і Kanban, метрики потоку, усунення перешкод і ретроспективи, після яких щось справді змінюється. На повну зайнятість у вашій команді, на часткову або на визначений період.
Технічна підтримка
Технічна підтримка програмних продуктів: інженери першої та другої лінії у вашому help desk, під вашим брендом і в робочі години ваших клієнтів. На повну зайнятість, на часткову або на запуск.
IT-рекрутинг
IT-рекрутинг для компаній, що збирають власні команди: опис ролей, пошук кандидатів, первинний відбір і технічні співбесіди, які проводять практикуючі інженери. IT-рекрутери у вашій команді або на період інтенсивного найму.
Customer success
Customer success для SaaS і підписних продуктів: менеджери з customer success відповідають за онбординг, використання продукту, health score, QBR і продовження підписок. На повну зайнятість у вашій команді, на часткову або на запуск.
Питання про найм: технічні письменники
Чи може технічний письменник задокументувати систему, яку ніхто не документував?
Так. Письменник читає код і конфігурацію, опитує інженерів і готує огляд архітектури, операційні інструкції та глосарій, які перевіряють люди, що експлуатують систему. Це той самий перший крок у режимі лише читання, з якого починається наше прийняття успадкованих систем від інших команд.
Як ви підтримуєте відповідність документації API самому API?
Довідник генерується зі схеми OpenAPI чи GraphQL під час збірки, тому розійтися з API він не може. Письменник додає те, чого не зробить генератор: посібник для швидкого старту, пояснення автентифікації та приклади, які потрібні розробнику, щоб довідник став корисним.
Як швидко можуть стати до роботи технічні письменники?
Якщо відповідний технічний письменник вільний, старт залежить лише від вашої співбесіди, NDA і передачі прав на інтелектуальну власність. Інакше ми проводимо пошук, який зазвичай дає профілі кандидатів за два-три тижні, і ніхто не починає роботу, доки ви не скажете «так».
Як найняти фахівців через BigTree108, якщо вам потрібні технічні письменники?
Розкажіть про роботу, рівень і години, які вам потрібні. Ми пропонуємо одну-двох людей з їхніми профілями, ви проводите з ними співбесіду так, як зі своїм власним кандидатом, підписуєте один договір із ТОВ «БІГ ТРІ 108» і отримуєте один рахунок на місяць.
Кому належать результати їхньої роботи?
Вам. Кожен фахівець має підписаний із BigTree108 договір, за яким усі результати роботи передаються компанії, а наш договір із вами передає їх далі. Код, дизайн-макети та документи постачаються у ваші власні репозиторії та інструменти, а не зберігаються там, де змінити їх можемо лише ми.
Документація відстає від продукту?
Розкажіть про продукт, його читачів і про те, де зараз зберігається документація. Відповідь ви отримаєте протягом одного робочого дня: профілі кандидатів або план роботи з документацією.