Перед вами історія про те, як Роману вдалося створити в компанії відділ для роботи з технічною документацією. Йдеться про державну ІТ-компанію, проте процеси будуть зрозумілі всім: від ідеї до масштабування. Поради будуть корисними як керівникам, що бачать потребу в такому відділі, так і технічним письменникам, які чуються в силі до нових звершень. 5
Якщо ви в пошуках інструменту, що допоміг би кожному учаснику робочого процесу чітко розуміти, які задачі йому виконувати, а також впорядкував би документацію і контент — хорошим рішенням може бути GitHub. Чому саме він і які основні його можливості можна ефективно використати для управління delivery-процесами — читайте в статті.
У статті Оксана Слюсарова розповідає, хто такий Technical Writer/Technical Communicator, яку роль цей фахівець виконує в софтвер-проєкті та в чому бізнес-цінність документування. Матеріал буде корисний для Project Managers, Product Owners, Talent Success Leads та інших спеціалістів, які ухвалюють рішення щодо залучення кадрів. 9
Коли ви розробляєте власний API, то один з найважливіших його атрибутів — це грамотна документація з прикладами. У цій статті Сергій Моренець висвітлює тему написання документації для розподілених систем, зокрема говоримо про використання AsyncAPI, можливості та відмінності цієї системи. 2
Стаття буде корисною, якщо у вас на проєкті виникали або виникають дилеми на кшталт «Писати чи не писати», а якщо писати документацію, то що і скільки. У цьому блозі Олеся Пасєка, Manual QA Engineer у Svitla Systems, описує власний досвід, як зорієнтуватись щодо необхідних документів на проєкті і підготувати їх з користю для команди. 16
Державна міграційна служба спростувала своє попереднє рішення про ануляцію паспортів і заявила, що всі документи лишаються дійсними. Водночас українців закликали замінити один із паспортів, щоб уніфікувати написання (якщо документи таки мають різну транслітерацію). 13
«Тема пресейлів стає все актуальнішою, адже український ІТ-аутсорс дещо втратив клієнтів останнім часом і багато компаній налягли на залучення нових». Ілля Шаповал ділиться технікою, яка може допомогти тим, хто задіяний у пресейлах, швидко зануритись у новий для себе чи компанії домен. 16
Стаття буде корисна для бізнес-аналітиків, продакт-менеджерів, розробників, тестувальників та й загалом усіх, хто хоче навчитись візуалізувати вимоги до проєкту. У ній вчимося створювати якісні UML-діаграми. 61
Як знайти баланс між відсутністю документації вимог та манускриптами на десятки й сотні сторінок? Катерина Харченко, CFA, PhD та product owner, розкриває у блозі головні питання, на які варто відповісти до того, як документувати вимоги. 17
Якщо останній місяць у вас було відчуття, що ви на нескінченному марафоні ІТ/ кібербезпеки, то ця інструкція з впровадження топових практик SANS Shields UP — шанс вирватися з нього. Текст доповнено практичними рекомендаціями, як діяти саме під час війни в Україні, інструкція підійде організаціям будь-якого розміру та галузі. 4
Каждый тестировщик с пеленок знает о тест-плане и тест-стратегии, но эти документы редко используют на проектах. Зачастую от них отказываются из-за непонимания всей пользы от высокоуровневой документации и нежелания тратить на неё время. Дмитрий Штапаук, Business Process Architect в Techstack, рассказывает о преимуществах их ведения, а также об элементах, которые превращают эти документы в инструмент, полезный для всей команды. 1
Реальність така, що не всі тестові сценарії завжди якісні. У цій публікації Володимир, QA, виокремлює кілька випадків, коли тестова документація замість того, щоб сприяти швидкій регресійній перевірці, навпаки, сповільнює її та сприяє слабкій перевірці продукту. Чому так відбувається і що робити — у матеріалі. 23
Стаття буде цікавою тим, хто вже замислювався про аудит процесів на проєкті, хто вже почав збирати метрики або тільки збирається це зробити — QA Manager, QA Lead, PM та навіть executive persons. У статті розглянемо, чим відрізняється аудит від оцінювання, а також для чого і як часто проводити аудит. 4
Ця стаття стане в пригоді як початківцям — людям, які щойно прийшли у професію і хочуть розібратися, з чого починати та яких помилок уникнути, — так і техрайтерам, які вже встигли попрацювати та набити ґуль і яким мій досвід може стати натхненням для пошуку нових рішень у створенні документації. 14
Проекты, требования к которым не предоставляются пользователями, а добываются из существующего кода — достаточно новый тип проектов. Но их актуальность только растет. В статье поговорим о Reverse Engineering, у которого есть свои законы и особенности. 10
Іван Чебан — про стайлгайди, якими користуються техрайтери, і чому це важливо. Ви дізнаєтеся про лінтер, як налаштувати лінтер Vale для перевірки текстів на відповідність вимогам стайлгайдів Microsoft і Google, а також як створити власний стайлгайд для Vale. Стаття стане в нагоді не тільки техрайтерам, але й усім, хто має справу з написанням документації англійською мовою. 12
Добре описана документація значно полегшує життя всім залученим у створення та підтримання продукту сторонам. Ісай Ірина, техрайтерка, ділиться своїм досвідом аудиту технічної та підготовки продуктової документації одночасно для кількох проєктів компанії. 4
Богдана Музика розвиває напрям бізнес-аналізу в компанії TechMagic і в цій статті ділиться власним досвідом застосування такої техніки, як User Flows, на різних етапах існування проєкту. Читати варто всім, хто працює з виявленням та документуванням вимог, дизайном, розробкою та тестуванням продукту і хоче навчитись краще розуміти його. 6
Ефективна комунікація та взаємодія є ключовим елементом успішності проєкту. У цьому матеріалі автор концентрується на технічній комунікації між бекенд- та фронтенд-розробниками, огляді архітектур, їхньому застосуванні для розв’язання різних питань і, головне, на підходах та інструментах з документування інтерфейсів. 23
Практически на всех проектах, где работал Software Testing Team Leader Юрий Бабай, был тест-план. Этот документ колоссально облегчал жизнь тестировщиков и делал ценность их работы для заказчика очевидной. Но есть одна деталь. Чтобы тест-план работал в интересах команды, надо составлять его с умом и задавая правильные вопросы клиенту. В этом материале поговорим о создании качественного тест-плана. 7
Коментарі