Služby technické dokumentace
Služby technické dokumentace pro softwarové firmy: reference API, příručky pro vývojáře, uživatelská dokumentace, runbooky a poznámky k vydání, psané jako kód vedle produktu a udržované aktuální s každým vydáním.
Co dělají naši techničtí autoři
Dokumentace API
Reference generovaná z vašeho schématu OpenAPI nebo GraphQL, s úvodními příručkami, průvodci autentizací a spustitelnými příklady napsanými kolem ní, takže reference se nikdy neupravuje ručně.
Docs as code
Dokumentace v Markdownu ve vašem repozitáři, revidovaná v pull requestech jako kód a publikovaná pomocí Docusaurus, Starlight nebo podobného generátoru stejnou pipeline jako produkt.
Uživatelské příručky a centra nápovědy
Úlohově orientované příručky a články centra nápovědy uspořádané podle toho, co se čtenář snaží udělat, členěné na tutoriály, how-to příručky, referenci a vysvětlení podle frameworku Diátaxis.
Runbooky a provozní příručky
Postupy krok za krokem pro nasazení, obnovy, reakci na incidenty a pohotovost, otestované někým, kdo je nepsal.
Poznámky k vydání a changelogy
Poznámky k vydání, které uživatelům říkají, co se změnilo pro ně, a changelogy pro integrátory, sepsané z mergnutých pull requestů a zkontrolované proti vydání.
Kontroly stylu a kvality
Příručka stylu a slovník pojmů, které v pipeline hlídá Vale, a kontrola nefunkčních odkazů při každém buildu, takže jednotnost nezávisí na jediném recenzentovi.
techničtí autoři do vašeho týmu
Na plný úvazek ve vašem týmu
Techničtí autoři, kteří pracují ve vaší pracovní době, ve vašich nástrojích a na vašich schůzkách a zodpovídají se vašemu vedoucímu, přičemž ukrajinská smlouva, mzdy a dovolená jsou na naší straně.
Na částečný úvazek nebo jen zlomek kapacity
Techničtí autoři na pevně daný počet dnů v týdnu, když je práce skutečná, ale zatím ne na plný úvazek.
Na projekt nebo spuštění
Techničtí autoři na vymezený úsek práce, od prvního týdne po předání, s datem ukončení dohodnutým předem.
Stránka o dedikovaném týmu vysvětluje, jak se specialisté připojují k vašemu týmu, a stránka o outsourcingu pokrývá dodávku projektů, převzetí systémů a jak účtujeme.
S kým spolupracují naši techničtí autoři
Inženýři a technické vedoucí
Rozhovory, revize a technická přesnost
Produktoví manažeři
Funkce, cílové skupiny a rozsah vydání
Inženýři podpory
Otázky, které uživatelé skutečně kladou
UI a UX designéři
Texty v rozhraní a diagramy
Jak pracují naši technickí spisovatelé
Dokumentace žije tam, kde kód: v repozitáři, je revidovaná ve stejném pull requestu jako změna, kterou popisuje, a buildí a publikuje ji pipeline. Funkce je hotová, až když je sloučená její dokumentace, takže dokumentace je tak aktuální jako kód.
Psaní vychází od čtenáře: kdo to je, co se snaží udělat a co už ví. Tickety podpory a vyhledávané výrazy ukazují, kde současná dokumentace selhává, a tyto stránky opravujeme jako první.
Další role, které zajišťujeme
Projektoví manažeři
Projektové řízení pro dodávku softwaru: IT projektoví a delivery manažeři, kteří vlastní plány, rozsah, rizika, rozpočty a týdenní reporting, na plný úvazek ve vašem týmu, na částečný úvazek nebo pro jediný projekt.
Business analytici
Business analýza pro softwarové projekty: discovery, požadavky, user stories, procesní mapy v BPMN a akceptační kritéria, od business analytiků na plný úvazek ve vašem týmu, na částečný úvazek nebo pro projekt.
Produktoví manažeři
Produktové řízení pro softwarové produkty: produktoví manažeři a product owneři pro discovery, roadmapy, backlogy a produktové metriky, na plný úvazek ve vašem týmu, několik dní v týdnu nebo pro spuštění.
Scrum mastery
Scrum mastery a agilní koučink pro softwarové týmy: Scrum a Kanban, metriky toku, odstraňování překážek a retrospektivy, které něco změní, na plný úvazek ve vašem týmu, na částečný úvazek nebo na stanovené období.
Technická podpora
Služby technické podpory pro softwarové produkty: inženýři podpory první a druhé úrovně ve vašem helpdesku, pod vaší značkou a v době, kdy jsou vaši zákazníci aktivní, na plný úvazek, na částečný úvazek nebo pro spuštění.
IT nábor
Služby IT náboru pro firmy, které budují vlastní týmy: zadání rolí, vyhledávání kandidátů, předvýběr a technické pohovory vedené praktikujícími inženýry, od IT recruiterů ve vašem týmu nebo pro nárazový nábor.
Customer success
Customer success management pro SaaS a předplatitelské produkty: customer success manažeři pro onboarding, adopci, health score, QBR a obnovy, na plný úvazek ve vašem týmu, na částečný úvazek nebo pro spuštění.
Otázky k najímání: techničtí autoři
Dokáže technický spisovatel zdokumentovat systém, který nikdo nezdokumentoval?
Ano. Spisovatel prostuduje kód a konfiguraci, vede rozhovory s inženýry a vytvoří přehled architektury, provozní příručky (runbooky) a slovník pojmů, které zkontrolují lidé, kteří systém provozují. Je to stejný první krok, jen pro čtení, jakým začínají naše převzetí zděděných systémů.
Jak udržujete dokumentaci API v souladu s API?
Referenční příručka se při buildu generuje ze schématu OpenAPI nebo GraphQL, takže se od API nemůže rozejít. Spisovatel doplní to, co generátor nedokáže: úvodní průvodce, výklad autentizace a příklady, které vývojář potřebuje dřív, než mu referenční příručka k něčemu bude.
Jak rychle mohou nastoupit techničtí autoři?
Když je k dispozici ten pravý technický autor, začátek brzdí jen váš pohovor, NDA a převod práv duševního vlastnictví. Jinak vedeme hledání, které obvykle přinese profily kandidátů do dvou až tří týdnů, a nikdo nenastoupí, dokud neřeknete ano.
Jak probíhá najímání přes BigTree108 (role: techničtí autoři)?
Řekněte nám, jakou práci, jakou seniority a kolik hodin potřebujete. Navrhneme jednoho nebo dva lidi s jejich profily, pohovoříte s nimi stejně jako s vlastním zaměstnancem a podepíšete jednu smlouvu s BIG TREE 108 LLC a budete dostávat jednu fakturu měsíčně.
Komu patří práce, kterou vytvářejí?
Vám. Každý specialista má podepsanou smlouvu s BigTree108, která převádí všechny výsledky práce na společnost, a naše smlouva s vámi je převádí dál. Kód, návrhy a dokumenty se dodávají do vašich vlastních repozitářů a nástrojů, ne do míst, kde je můžeme měnit jen my.
Zaostává vaše dokumentace za produktem?
Napište nám, o jaký produkt jde, kdo jsou jeho čtenáři a kde dokumentace žije dnes. Odpověď dostanete do jednoho pracovního dne: profily kandidátů, nebo plán dokumentace.