Șapte motive pentru a utiliza Confluence pentru documentația tehnică

Când redactorii tehnici se întâlnesc la conferințe, una dintre primele întrebări este de obicei: „Ce instrument de creare de ajutor utilizați pentru a produce conținut de ajutor?”. Iar această întrebare este urmată rapid de „Și ce instrument ați dori să folosiți în schimb?”

În acest moment, majoritatea oamenilor din comunitatea techcomm se așteaptă la un răspuns precum „FrameMaker”, „Flare” sau un CMS. Dar când îl întreabă pe Nils Bier, redactor tehnic la K15t, acesta îi nedumerește cu răspunsul său. „Noi folosim Confluence, wiki-ul de întreprindere și spațiul de lucru în echipă, combinat cu cele mai recente aplicații Scroll Apps. Iar în ceea ce privește a doua întrebare – Confluence este, de asemenea, instrumentul meu preferat pentru gestionarea conținutului de ajutor și a documentației de produs.” Iată de ce.

#1 – Confluence poate fi folosit la nivelul întregii companii

La K15t, folosim Confluence în toate departamentele noastre. Toți angajații împărtășesc informații relevante în cadrul spațiilor interne Confluence. Dezvoltatorii își organizează specificațiile și își înregistrează deciziile de proiectare în Confluence. Următorul pas logic, așadar, este să folosim Confluence pentru a gestiona documentația de asistență și de produs. Puteți vedea centrul nostru de asistență bazat pe Confluence aici.

Pentru că noi credem că este atât de important să ai un cont de utilizator Confluence, toți noii angajați K15t primesc unul în același timp în care primesc adresele de e-mail personale. Acest lucru înseamnă că fiecare angajat de la K15t are un cont de utilizator Confluence din prima zi – astfel încât să poată accesa wiki și să ajute la contribuția, dezvoltarea și îmbunătățirea documentației. Și funcționează: colaborăm cu toții în același instrument! Această platformă wiki permite tuturor să partajeze, să comenteze și să îmbunătățească ușor conținutul. Același lucru este valabil și pentru documentația produselor noastre în Confluence.

Și Nils știe că nu se oprește aici. „Folosim Confluence chiar și pentru a gestiona conținutul pentru site-ul și blogul nostru.” Este adevărat! Articolul de blog pe care îl citiți acum este livrat din Confluence prin Scroll Viewport.

#2 – Confluence funcționează așa cum vă așteptați

Cine a văzut Confluence o dată știe cum să îl folosească aproape instantaneu. Și, spre deosebire de alte motoare wiki, Confluence îi inspiră cu adevărat pe utilizatori să lucreze cu el. Confluence are o interfață de utilizator curată și un editor care funcționează într-un mod foarte asemănător cu un software comun de editare desktop (DTP) sau cu instrumente de procesare a textelor, cum ar fi Microsoft Word.

Utilizatorii noi au nevoie de foarte puțină instruire înainte de a fi gata să lucreze cu Confluence – spre deosebire de platformele complexe de creare de ajutor. Ei pur și simplu se apucă de treabă – și destul de curând, toți noii utilizatori Confluence scriu, comentează și partajează ca niște profesioniști.

Confluence oferă șabloane de pagini (de exemplu, pentru note de ședință sau șabloane de pagini personalizate pentru documentația de asistență) pentru a ajuta utilizatorii să dezvolte conținut rapid și consecvent. Aceasta este o modalitate excelentă de a asigura structuri de pagini și conținut consecvent. Dar atunci când autorii decid să meargă dincolo de șabloanele lor, pot face și asta.

Nils adoră acest lucru. „Confluence îmi permite să-mi structurez conținutul – dar, în același timp, le oferă utilizatorilor libertatea de a fi creativi.”

#3 – Confluence vă permite să implicați colegii și cititorii

Părtășirea paginilor Confluence cu colegii este simplă. Puteți partaja cea mai recentă versiune a unei pagini din documentație cu doar câteva clicuri. La K15t, membrii personalului lasă adesea comentarii pe pagini ca o modalitate de a-și împărtăși opiniile. Toți cei care urmăresc pagina primesc o notificare atunci când a fost adăugat un comentariu.

Dar caracteristica socială preferată a lui Nils din Confluence este butonul „Like”, care este similar cu un like pe Facebook. Utilizatorul face clic pe „Like” pentru a confirma că totul pe pagină este corect și că nu mai sunt necesare alte îmbunătățiri.

Wikis-urile precum Confluence fac colaborarea mult mai ușoară pentru toată lumea decât platformele tipice de creare de ajutor, care sunt potrivite doar pentru scriitorii tehnici. În cele mai multe cazuri în care companiile nu merg pe calea wiki, conținutul trebuie să fie exportat din CMS pentru a fi revizuit de colegii din alte departamente. Iar după ce au terminat, adnotările și cererile de modificare ale acestora trebuie reimportate și procesate manual.

#4 – Confluence este bazat pe Web

Nu este nevoie să instalați nimic pe computerul dumneavoastră pentru a lucra în Confluence. Tot ce aveți nevoie este browserul dvs. web preferat (cum ar fi Chrome sau Firefox) și contul dvs. personal de utilizator. Tot conținutul este gestionat în mod centralizat pe serverul Confluence al corporației, sau puteți merge pe calea Cloud cu Confluence Cloud. Acest lucru înseamnă că toată lumea din compania dvs. are acces la cele mai recente informații și poate actualiza, partaja și contribui la conținut – oricând, oriunde: la sediul central, la o filială sau chiar atunci când se află într-o călătorie de afaceri.

Nils este un fan al abordării bazate pe web a Confluence: „Nu mai trebuie să-mi fac griji cu privire la actualizarea lanțului de instrumente de creare a ajutorului local, deoarece Confluence este singurul instrument de gestionare a conținutului pe care administratorii noștri trebuie să-l țină la zi.”

#5 – Confluence oferă transparență totală la crearea de conținut

Ideea din spatele colaborării bazate pe wiki este aceea de a permite oricui să contribuie și de a oferi acces liber la cunoștințele din interior. Utilizatorii pot urmări și compara paginile pentru a se înarma cu cele mai recente cunoștințe corporative și pentru a observa modul în care evoluează conținutul. Documentația crește literalmente sub ochii cuiva.

Dar uneori nu are sens să se împărtășească informațiile cu toți angajații. Ținând cont de acest lucru, Confluence vă permite să restricționați accesul și include gestionarea fină a drepturilor și a rolurilor. Puteți defini cu ușurință cine are voie să citească, să editeze sau să lase comentarii pe fiecare pagină sau spațiu, de exemplu.

#6 – Puteți personaliza Confluence pentru a se potrivi cazului dumneavoastră de utilizare cu câteva aplicații (de derulare) excelente

Confluence nu este un sistem de gestionare a conținutului (CMS) ca atare. Dar este o platformă extensibilă – și există o gamă imensă de aplicații care să se potrivească cazului dumneavoastră de utilizare, de exemplu, gestionarea conținutului pentru documentația tehnică. De exemplu, Scroll Versions aduce versiuni concomitente și gestionarea variantelor în Confluence Server și Data Center și face legătura între un CMS complet și un wiki ușor de utilizat. Dacă sunteți un utilizator Confluence Cloud, Scroll Documents vă permite să controlați versiunile, să urmăriți modificările și să gestionați fluxul de dezvoltare a conținutului ca o echipă de documentare.

Nils adaugă: „De fapt, nu-mi mai pot imagina să lucrez fără aceste aplicații Scroll pentru Confluence. Ele îmi economisesc atât de mult timp – timp pe care îl pot petrece acum scriind, în loc să copiez și să gestionez manual conținutul de ajutor.”

#7 – Confluence este ideal pentru mediile agile

Ca multe companii de software, K15t urmează paradigma de dezvoltare agilă. Documentația de suport, ca și produsele, evoluează iterativ în cadrul sprinturilor și versiunilor. Pe măsură ce ciclurile de lansare devin din ce în ce mai scurte, redactorii tehnici trebuie să țină pasul. Acest lucru este posibil numai dacă toți membrii echipei lucrează cu același instrument, unde pot contribui cu informații și pot oferi feedback instantaneu asupra conținutului de asistență.

Nils descrie fluxul său de lucru pentru eliberarea documentației. „Lucrez la următoarea versiune a documentației noastre, iar când dezvoltatorii noștri scot pe ușă lansarea produsului, pur și simplu public și actualizez conținutul de ajutor folosind Scroll Versions. Este nevoie doar de câteva clicuri.”

Concluzie: Mai multe cazuri de utilizare (și motive) care vor urma

Confluence a început ca o platformă de gestionare a cunoștințelor și de colaborare. Utilizatorii au venit cu modalități de valorificare a acestei platforme pentru alte cazuri de utilizare și au atras noi audiențe. Și, în același mod, numărul motivelor de utilizare a Confluence pentru documentația tehnică crește pe zi ce trece – cu fiecare nouă versiune Confluence și cu fiecare nouă aplicație care sosește pe Atlassian Marketplace.

Care sunt motivele pentru care utilizați sau evaluați Confluence pentru documentația tehnică? Și unde vedeți avantajele în comparație cu instrumentele tradiționale de creare de ajutor? Vă rugăm să lăsați un comentariu și să ne spuneți!