Usługi dokumentacji technicznej
Usługi dokumentacji technicznej dla firm programistycznych: referencje API, przewodniki dla programistów, dokumentacja użytkownika, runbooki i notatki do wydań, pisane jako kod obok produktu i aktualizowane z każdym wydaniem.
Czym zajmują się nasi technical writerzy
Dokumentacja API
Referencja generowana z Państwa schematu OpenAPI lub GraphQL, z przewodnikami na start, omówieniami uwierzytelniania i przykładami do uruchomienia napisanymi wokół niej, tak aby referencji nigdy nie edytowano ręcznie.
Docs as code
Dokumentacja w Markdown w Państwa repozytorium, przeglądana w pull requestach jak kod i publikowana za pomocą Docusaurus, Starlight lub podobnego generatora przez ten sam pipeline co produkt.
Przewodniki użytkownika i centra pomocy
Przewodniki zadaniowe i artykuły centrum pomocy zorganizowane według tego, co czytelnik próbuje zrobić, podzielone na tutoriale, przewodniki how-to, referencje i wyjaśnienia zgodnie z frameworkiem Diátaxis.
Runbooki i przewodniki operacyjne
Procedury krok po kroku dla wdrożeń, odtwarzania, reagowania na incydenty i dyżurów, przetestowane przez osobę, która ich nie pisała.
Notatki do wydań i changelogi
Notatki do wydań mówiące użytkownikom, co się dla nich zmieniło, oraz changelogi dla integratorów, przygotowywane z zatwierdzonych pull requestów i sprawdzane względem wydania.
Kontrole stylu i jakości
Przewodnik stylu i lista terminologii egzekwowane przez Vale w pipeline, a przy każdym buildzie także kontrola uszkodzonych linków, dzięki czemu spójność nie zależy od jednego recenzenta.
Zatrudnienie: technical writerzy
Na pełny etat w Państwa zespole
Technical writerzy pracują w Państwa godzinach, w Państwa narzędziach i na Państwa spotkaniach oraz podlegają Państwa liderowi, a ukraińska umowa, wynagrodzenia i urlopy są po naszej stronie.
Na część etatu
Technical writerzy dostępni przez ustaloną liczbę dni w tygodniu, gdy pracy jest realnie dużo, ale nie jest to jeszcze pełny etat.
Na czas projektu lub startu produktu
Technical writerzy do określonego etapu prac, od pierwszego tygodnia do przekazania, z datą zakończenia uzgodnioną z góry.
Strona o dedykowanym zespole wyjaśnia, jak specjaliści dołączają do Państwa zespołu, a strona o outsourcingu opisuje realizację projektów, przejęcia i sposób rozliczania.
Z kim współpracują nasi technical writerzy
Inżynierowie i liderzy techniczni
Wywiady, recenzje i poprawność techniczna
Product managerowie
Funkcje, odbiorcy i zakres wydania
Inżynierowie wsparcia
Pytania, które użytkownicy naprawdę zadają
Projektanci UI i UX
Teksty interfejsu i diagramy
Jak pracują nasi technical writerzy
Dokumentacja żyje tam, gdzie kod: w repozytorium, recenzowana w tym samym pull requeście co zmiana, którą opisuje, a budowana i publikowana przez pipeline. Funkcja jest skończona, gdy jej dokumentacja trafiła do głównej gałęzi, dzięki czemu dokumentacja jest tak aktualna jak kod.
Pisanie zaczyna się od czytelnika: kim jest, co próbuje zrobić i co już wie. Zgłoszenia do wsparcia i frazy wyszukiwane przez użytkowników pokazują, gdzie obecna dokumentacja zawodzi, i te strony poprawiamy w pierwszej kolejności.
Pozostałe role, które obsadzamy
Project managerowie
Zarządzanie projektami realizacji oprogramowania: project managerowie i delivery managerowie IT, którzy odpowiadają za plany, zakres, ryzyka, budżety i cotygodniowe raportowanie, w pełnym wymiarze w Państwa zespole, w niepełnym wymiarze lub przy pojedynczym projekcie.
Analitycy biznesowi
Analiza biznesowa dla projektów programistycznych: discovery, wymagania, user stories, mapy procesów BPMN i kryteria akceptacji, od analityków biznesowych w pełnym wymiarze w Państwa zespole, w niepełnym wymiarze lub na projekt.
Product managerowie
Zarządzanie produktem dla produktów programistycznych: product managerowie i product ownerzy do discovery, roadmap, backlogów i metryk produktu, w pełnym wymiarze w Państwa zespole, kilka dni w tygodniu lub na czas premiery.
Scrum masterzy
Scrum masterzy i coaching agile dla zespołów programistycznych: Scrum i Kanban, metryki przepływu, usuwanie przeszkód i retrospektywy, które coś zmieniają, w pełnym wymiarze w Państwa zespole, w niepełnym wymiarze lub na określony czas.
Wsparcie techniczne
Usługi wsparcia technicznego dla produktów programistycznych: inżynierowie wsparcia pierwszej i drugiej linii w Państwa help desku, pod Państwa marką i w godzinach pracy Państwa klientów, w pełnym wymiarze, w niepełnym wymiarze lub na czas premiery.
Rekrutacja IT
Usługi rekrutacji IT dla firm budujących własne zespoły: opisy stanowisk, sourcing, selekcja i rozmowy techniczne prowadzone przez pracujących inżynierów, od rekruterów IT w Państwa zespole lub na intensywną akcję rekrutacyjną.
Customer success
Zarządzanie customer success dla SaaS i produktów subskrypcyjnych: customer success managerowie do onboardingu, adopcji, wskaźników kondycji klienta, QBR i odnowień, w pełnym wymiarze w Państwa zespole, w niepełnym wymiarze lub na czas premiery.
Pytania o zatrudnienie: technical writerzy
Czy technical writer może opisać system, którego nikt wcześniej nie udokumentował?
Tak. Technical writer czyta kod i konfigurację, rozmawia z inżynierami i przygotowuje przegląd architektury, runbooki i glosariusz, które sprawdzają osoby obsługujące system. To ten sam pierwszy krok, bez zmian w systemie, od którego zaczynają się nasze przejęcia odziedziczonych systemów.
Jak utrzymują Państwo dokumentację API w zgodzie z API?
Dokumentacja referencyjna jest generowana w buildzie ze schematu OpenAPI lub GraphQL, więc nie może rozjechać się z API. Technical writer dodaje to, czego generator nie napisze: przewodnik na start, opis uwierzytelniania i przykłady, których programista potrzebuje, zanim dokumentacja referencyjna stanie się przydatna.
Jak szybko mogą zacząć technical writerzy?
Gdy odpowiedni technical writer jest dostępny, o terminie startu decydują wyłącznie Państwa rozmowa oraz NDA i przeniesienie praw własności intelektualnej. W przeciwnym razie prowadzimy poszukiwania, które zwykle dają profile kandydatów w ciągu dwóch do trzech tygodni, a nikt nie zaczyna pracy, dopóki Państwo nie powiedzą „tak”.
Jak wygląda zatrudnienie przez BigTree108: technical writerzy?
Prosimy o informację o zakresie pracy, poziomie doświadczenia i potrzebnych godzinach. Proponujemy jedną lub dwie osoby wraz z ich profilami, Państwo przeprowadzają z nimi rozmowy tak, jak z własnym kandydatem, podpisują jedną umowę z BIG TREE 108 LLC i otrzymują jedną fakturę miesięcznie.
Do kogo należy praca, którą wykonują?
Do Państwa. Każdy specjalista ma podpisaną z BigTree108 umowę, która przenosi wszystkie rezultaty pracy na spółkę, a nasza umowa z Państwem przenosi je dalej. Kod, projekty i dokumenty są przekazywane do Państwa własnych repozytoriów i narzędzi, a nie przechowywane tam, gdzie zmieniać je możemy tylko my.
Dokumentacja nie nadąża za produktem?
Prosimy o informację o produkcie, jego czytelnikach i o tym, gdzie dziś znajduje się dokumentacja. Odpowiedź otrzymają Państwo w ciągu jednego dnia roboczego: profile kandydatów lub plan dokumentacji.