Sedm důvodů, proč používat Confluence pro technickou dokumentaci

Když se techničtí autoři setkávají na konferencích, jedna z prvních otázek obvykle zní: „Který nástroj pro tvorbu nápovědy používáte k tvorbě obsahu nápovědy?“. A po této otázce rychle následuje otázka: „A který nástroj byste chtěli používat místo toho?“

V tomto okamžiku většina lidí v komunitě techcomm očekává odpověď typu „FrameMaker“, „Flare“ nebo CMS. Když se však zeptají Nilse Biera, technického spisovatele ve společnosti K15t, svou odpovědí je vyvede z míry. „Používáme Confluence, podnikovou wiki a týmový pracovní prostor, v kombinaci s našimi nejnovějšími aplikacemi Scroll Apps. A pokud jde o druhou otázku – Confluence je také můj oblíbený nástroj pro správu obsahu nápovědy a produktové dokumentace.“ Zde je důvod.

#1 – Confluence lze používat v celé firmě

V K15t používáme Confluence ve všech našich odděleních. Všichni zaměstnanci sdílejí příslušné informace v rámci interních prostorů Confluence. Vývojáři organizují své specifikace a zaznamenávají svá návrhová rozhodnutí v Confluence. Dalším logickým krokem je tedy použití Confluence ke správě dokumentace podpory a produktů. Naše centrum nápovědy založené na Confluence si můžete prohlédnout zde.

Protože považujeme za velmi důležité mít uživatelský účet Confluence, všichni noví zaměstnanci společnosti K15t jej dostávají současně s osobní e-mailovou adresou. To znamená, že každý zaměstnanec společnosti K15t má uživatelský účet Confluence od prvního dne – může tak přistupovat k wiki a pomáhat přispívat do dokumentace, rozvíjet ji a zlepšovat. A funguje to: všichni spolupracujeme ve stejném nástroji! Tato platforma wiki umožňuje všem snadno sdílet, komentovat a vylepšovat obsah. Totéž platí pro dokumentaci našich produktů v Confluence.

A Nils ví, že tím to nekončí. „Používáme Confluence i ke správě obsahu našich webových stránek a blogu“. Je to pravda! Příspěvek na blogu, který právě čtete, je dodáván z Confluence pomocí Scroll Viewport.

#2 – Confluence funguje tak, jak očekáváte

Každý, kdo Confluence jednou viděl, ví, jak ho používat, téměř okamžitě. A na rozdíl od jiných wiki enginů Confluence uživatele skutečně inspiruje k práci s ním. Confluence má čisté uživatelské rozhraní a editor, který funguje velmi podobně jako běžný software pro stolní publikování (DTP) nebo nástroje pro zpracování textu, například Microsoft Word.

Noví uživatelé potřebují jen velmi málo školení, než jsou připraveni pracovat s Confluence – na rozdíl od složitých platforem pro tvorbu nápovědy. Prostě se do toho pustí – a zanedlouho už všichni noví uživatelé Confluence píší, komentují a sdílejí jako profesionálové.

Confluence poskytuje šablony stránek (např. pro poznámky z porad nebo vlastní šablony stránek pro dokumentaci podpory), které uživatelům pomáhají rychle a důsledně vytvářet obsah. Je to skvělý způsob, jak zajistit konzistentní strukturu a obsah stránek. Když se však autoři rozhodnou jít nad rámec svých šablon, mohou to udělat také.

Nilsovi se to líbí. „Confluence mi umožňuje strukturovat obsah – ale zároveň dává uživatelům svobodu být kreativní.“

#3 – Confluence umožňuje zapojit kolegy a čtenáře

Sdílení stránek Confluence s kolegy je jednoduché. Nejnovější verzi stránky v dokumentaci můžete sdílet na několik kliknutí. Ve společnosti K15t zaměstnanci často zanechávají na stránkách komentáře jako způsob sdílení svých postřehů. Všichni, kdo stránku sledují, dostanou oznámení o přidání komentáře.

Nilsovou oblíbenou sociální funkcí Confluence je však tlačítko „To se mi líbí“, které se podobá lajku na Facebooku. Uživatel kliknutím na „To se mi líbí“ potvrdí, že vše na stránce je správně a není třeba nic dále vylepšovat.

Wiky jako Confluence umožňují mnohem snazší spolupráci pro všechny než typické platformy pro psaní nápovědy, které jsou vhodné pouze pro technické autory. Ve většině případů, kdy společnosti nejdou cestou wiki, musí být obsah exportován ze systému CMS ke kontrole kolegy z jiných oddělení. A jakmile jsou hotovi, musí být jejich anotace a požadavky na změny znovu importovány a zpracovány ručně.

#4 – Confluence je založen na webu

Pro práci v Confluence nemusíte do počítače nic instalovat. Potřebujete pouze svůj oblíbený webový prohlížeč (například Chrome nebo Firefox) a svůj osobní uživatelský účet. Veškerý obsah je spravován centrálně na vašem firemním serveru Confluence nebo můžete jít cestou cloudu pomocí služby Confluence Cloud. To znamená, že všichni ve vaší společnosti mají přístup k nejnovějším informacím a mohou obsah aktualizovat, sdílet a přispívat do něj – kdykoli a kdekoli: v centrále, na pobočce nebo dokonce na služební cestě.

Nils je fanouškem webového přístupu Confluence: „

#5 – Confluence nabízí plnou transparentnost při tvorbě obsahu

Smyslem spolupráce na bázi wiki je umožnit komukoli přispívat a poskytnout volný přístup ke znalostem uvnitř. Uživatelé mohou sledovat a porovnávat stránky, aby se vyzbrojili nejnovějšími firemními znalostmi a sledovali, jak se obsah vyvíjí. Dokumentace tak doslova roste před očima.

Někdy však nemá smysl sdílet informace se všemi zaměstnanci. S ohledem na tuto skutečnost umožňuje Confluence omezit přístup a obsahuje jemnou správu práv a rolí. Můžete snadno definovat, kdo smí například číst, upravovat nebo zanechávat komentáře na jednotlivých stránkách nebo místech.

#6 – Confluence můžete přizpůsobit svému případu použití pomocí některých skvělých (rolovacích) aplikací

Confluence není systém pro správu obsahu (CMS) jako takový. Je to však rozšiřitelná platforma – a existuje obrovské množství aplikací, které se hodí pro váš případ použití, např. pro správu obsahu technické dokumentace. Například aplikace Scroll Versions přináší do serveru a datového centra Confluence souběžnou správu verzí a variant a vyplňuje mezeru mezi plnohodnotným systémem CMS a snadno použitelnou wiki. Pokud jste uživatelem Confluence Cloud, Scroll Documents vám umožní řídit verze, sledovat změny a spravovat pracovní postup vývoje obsahu jako dokumentační tým. „Vlastně si už nedokážu představit práci bez těchto aplikací Scroll Apps pro Confluence. Ušetří mi tolik času – času, který teď mohu věnovat psaní, místo abych ručně kopíroval a spravoval obsah nápovědy.“

#7 – Confluence je ideální pro agilní prostředí

Stejně jako mnoho softwarových společností se i K15t řídí agilním paradigmatem vývoje. Dokumentace podpory se stejně jako produkty vyvíjí iterativně v rámci sprintů a vydání. Vzhledem k tomu, že cykly vydání jsou stále kratší a kratší, musí techničtí autoři držet krok. To je možné pouze tehdy, pokud všichni v týmu pracují se stejným nástrojem, kde mohou přispívat informacemi a poskytovat okamžitou zpětnou vazbu k obsahu nápovědy.

Nils popisuje svůj pracovní postup při vydávání dokumentace. „Pracuji na další verzi naší dokumentace, a když naši vývojáři vydají verzi produktu, jednoduše publikuji a aktualizuji obsah nápovědy pomocí nástroje Scroll Versions. Zabere to jen pár kliknutí.“

Závěr:

Confluence začínal jako platforma pro správu znalostí a spolupráci. Uživatelé přišli na způsoby, jak tuto platformu využít pro další případy použití, a přilákali nové publikum. A stejně tak se denně zvyšuje počet důvodů, proč používat Confluence pro technickou dokumentaci – s každou novou verzí Confluence a s každou novou aplikací, která přichází na trh Atlassian Marketplace.

Jaké jsou vaše důvody pro používání nebo hodnocení Confluence pro technickou dokumentaci? A v čem vidíte výhody ve srovnání s tradičními nástroji pro tvorbu nápovědy? Zanechte nám prosím komentář a dejte nám vědět!

Pokud máte nějaké otázky, neváhejte nám napsat na [email protected] .

.