TechWord / Softwarová dokumentace
Softwarová dokumentace
Dokumentace, která drží krok s vaším kódem a rozumí jí vývojář i jeho AI asistent
Dokumentace k softwaru zastarává rychleji než cokoli jiného, co k produktu vydáte. Píšeme ji anglicky i česky a tak, aby se verzovala vedle kódu, procházela stejným review a nezaostávala za každým mergem a změnou API. Zůstává tak přesná a použitelná pro člověka i pro nástroje, které ji dnes čtou.
Co pro vás uděláme
Dokumentace ve stejném workflow jako kód
Docs-as-code jako výchozí způsob práce
Dokumentaci píšeme v markdownu a spravujeme ji stejně jako váš zdrojový kód: v Gitu, přes pull requesty, s nasazením přes CI/CD. Vývojář navrhne změnu dokumentace ve stejném workflow, na jaký je zvyklý u kódu, a nemusí přepínat do odděleného nástroje. Dokumentace se tak aktualizuje současně s produktem.
API a OpenAPI reference
Vytváříme referenční dokumentaci k API, včetně reference generované z OpenAPI specifikace a udržované v souladu s ní. Popíšeme endpointy, parametry, autentizaci i chybové stavy s příklady, které vývojář zkopíruje a rovnou použije. Reference zůstává synchronizovaná se specifikací, takže se dokumentace nerozejde s tím, jak se API mezi verzemi vyvíjí.
Průvodci pro uživatele i vývojáře
Kromě reference píšeme i to, co uživatele reálně provede: onboarding, návody krok za krokem, tutoriály a koncepční vysvětlení, jak produkt zapadá do většího celku. Reference řekne, co endpoint dělá. Průvodce řekne, proč a kdy ho použít, aby se integrace povedla napoprvé a nesypaly se na vás support tickety.
Připravené i pro AI asistenty
Dokumentaci dnes čtou i AI asistenti, kterých se vývojáři ptají při práci. Strukturujeme obsah tak, aby ho tyto nástroje správně přečetly a interpretovaly, a na přání připravíme i formáty jako llms.txt. Vaše dokumentace tak obslouží obě publika, aniž byste kvůli tomu psali všechno dvakrát.
Rozumíme kódu i lidskému jazyku
Do týmu patří lidé s technickým zázemím, kteří čtou kód, orientují se v API a poznají, když v podkladech něco nesedí. Každý příklad v dokumentaci spustíme, než ho zveřejníme. Pracujeme ve stejných nástrojích jako váš tým a změny procházejí review přes pull request, takže dokumentaci máte pod kontrolou stejně jako kód. Za 33 let jsme zpracovali dokumentaci napříč obory, takže do vašeho stacku a terminologie naskočíme rychle.
Lokalizace
Dokumentace i aplikace v jazycích vašich trhů
Dokumentaci píšeme anglicky i česky. Další jazyky zajišťuje divize TechWord Lingua, která lokalizaci napojí na váš vývojový proces – od řetězců aplikace a chybových hlášení po nápovědu a marketingové texty. Termíny zůstávají stejné v dokumentaci, rozhraní i komunikaci a do další verze se překládá jen to, co se změnilo.
Jak spolupráce probíhá
- Konzultace nad produktem, repozitářem a publikačním řetězcem
- Návrh struktury dokumentace (reference, průvodci, koncepty) a nabídka
- Psaní přes pull requesty, review společně s vaším týmem
- Nasazení přes CI/CD a nastavení údržby při změnách API
Co od nás dostanete
- Dokumentaci v markdownu přímo ve vašem repozitáři
- API referenci generovanou z OpenAPI specifikace
- Průvodce a tutoriály pro onboarding uživatelů i vývojářů
- Na přání llms.txt a strukturu čitelnou pro AI asistenty
Máte software, jehož dokumentace zaostává za kódem?
Ozvěte se nám na nezávaznou konzultaci.