Sju skäl att använda Confluence för teknisk dokumentation

När tekniska skribenter träffas på konferenser brukar en av de allra första frågorna vara: ”Vilket hjälpverktyg använder ni för att producera hjälpinnehåll?” Och den frågan följs snabbt av: ”Och vilket verktyg skulle du vilja använda istället?”

I det här läget förväntar sig de flesta inom techcomm community ett svar som ”FrameMaker”, ”Flare” eller ett CMS. Men när de frågar Nils Bier, teknisk skribent på K15t, förbryllar han dem med sitt svar. ”Vi använder Confluence, företagets wiki och arbetsyta för team, i kombination med vår senaste Scroll Apps. Och när det gäller den andra frågan – Confluence är också mitt favoritverktyg för att hantera hjälpinnehåll och produktdokumentation.” Här är varför.

#1 – Confluence kan användas i hela företaget

På K15t använder vi Confluence på alla våra avdelningar. Alla anställda delar relevant information i interna Confluence-utrymmen. Utvecklare organiserar sina specifikationer och registrerar sina designbeslut i Confluence. Nästa logiska steg är därför att använda Confluence för att hantera support och produktdokumentation. Du kan se vårt Confluence-baserade hjälpcenter här.

Om vi tycker att det är så viktigt att ha ett Confluence-användarkonto får alla nya K15t-anställda ett sådant samtidigt som de får sina personliga e-postadresser. Detta innebär att alla anställda på K15t har ett Confluence-användarkonto från dag ett – så att de kan få tillgång till wikin och hjälpa till att bidra till, utveckla och förbättra dokumentationen. Och det fungerar: vi samarbetar alla i samma verktyg! Denna wiki-plattform gör det enkelt för alla att dela, kommentera och förbättra innehållet. Samma sak gäller för vår produktdokumentation i Confluence.

Och Nils vet att det inte slutar där. ”Vi använder även Confluence för att hantera innehåll för vår webbplats och blogg.” Det är sant! Blogginlägget som du läser just nu levereras från Confluence av Scroll Viewport.

#2 – Confluence fungerar som du förväntar dig

Alla som har sett Confluence en gång vet hur man använder det nästan omedelbart. Och till skillnad från andra wikimotorer inspirerar Confluence verkligen användarna att arbeta med det. Confluence har ett rent användargränssnitt och en editor som fungerar på ett mycket likartat sätt som vanliga DTP-program (desktop publishing) eller ordbehandlingsverktyg, till exempel Microsoft Word.

Nya användare behöver mycket lite utbildning innan de är redo att arbeta med Confluence – i motsats till komplexa plattformar för hjälpförfattare. Det är bara att sätta igång – och ganska snart skriver, kommenterar och delar alla nya Confluence-användare som ett proffs.

Confluence tillhandahåller sidmallar (t.ex. för mötesanteckningar eller anpassade sidmallar för supportdokumentation) för att hjälpa användarna att utveckla innehåll snabbt och konsekvent. Detta är ett utmärkt sätt att säkerställa konsekventa sidstrukturer och innehåll. Men när författare bestämmer sig för att gå utanför sina mallar kan de också göra det.

Nils älskar detta. ”Confluence låter mig strukturera mitt innehåll – men samtidigt ger det användarna friheten att vara kreativa.”

#3 – Confluence låter dig engagera kollegor och läsare

Det är enkelt att dela Confluence-sidor med kollegor. Du kan dela den senaste versionen av en sida i dokumentationen med några få klick. På K15t lämnar personalen ofta kommentarer på sidor som ett sätt att dela med sig av sina insikter. Alla som tittar på sidan får ett meddelande när en kommentar har lagts till.

Men Nils favorit sociala funktion i Confluence är ”Gilla”-knappen, som liknar en gilla-knapp på Facebook. Användaren klickar på ”Gillar” för att bekräfta att allt på sidan är korrekt och att inga ytterligare förbättringar behövs.

Wikis som Confluence gör det mycket enklare för alla att samarbeta än typiska plattformar för hjälpförfattare, som bara är lämpliga för tekniska skribenter. I de flesta fall där företag inte går wiki-vägen måste innehållet exporteras från CMS:et för att granskas av kollegor från andra avdelningar. Och när de är klara måste deras anteckningar och ändringsförfrågningar återimporteras och behandlas manuellt.

#4 – Confluence är webbaserat

Du behöver inte installera något på din dator för att arbeta i Confluence. Allt du behöver är din favoritwebbläsare (till exempel Chrome eller Firefox) och ditt personliga användarkonto. Allt innehåll hanteras centralt på företagets Confluence-server, eller så kan du gå över till molnet med Confluence Cloud. Detta innebär att alla i företaget har tillgång till den senaste informationen och kan uppdatera, dela och bidra med innehåll – när som helst och var som helst: på huvudkontoret, på ett filialkontor eller till och med på en affärsresa.

Nils är ett fan av Confluences webbaserade tillvägagångssätt: ”Jag behöver inte längre oroa mig för att uppdatera min lokala verktygskedja för hjälpförfattare, eftersom Confluence är det enda verktyg för innehållshantering som våra administratörer behöver hålla uppdaterat.”

#5 – Confluence erbjuder full insyn när man skapar innehåll

Tanken bakom wikibaserat samarbete är att vem som helst ska kunna bidra och ge fri tillgång till den kunskap som finns inuti. Användare kan titta på och jämföra sidor för att beväpna sig med den senaste företagskunskapen och observera hur innehållet utvecklas. Dokumentationen växer bokstavligen framför ens ögon.

Men ibland är det inte meningsfullt att dela information med alla anställda. Med detta i åtanke kan du med Confluence begränsa åtkomsten och inkluderar finkornig rättighets- och rollhantering. Du kan enkelt definiera vem som får läsa, redigera eller lämna kommentarer på varje sida eller utrymme, till exempel.

#6 – Du kan anpassa Confluence så att det passar ditt användningsområde med några bra appar

Confluence är inte ett innehållshanteringssystem (CMS) som sådant. Men det är en utbyggbar plattform – och det finns ett stort utbud av appar som passar ditt användningsområde, t.ex. hantering av innehåll för teknisk dokumentation. Scroll Versions ger till exempel samtidig versionshantering och varianthantering till Confluence Server och Data Center, och överbryggar klyftan mellan ett fullfjädrad CMS och en lättanvänd wiki. Om du använder Confluence Cloud kan du med Scroll Documents styra versioner, spåra ändringar och hantera arbetsflödet för innehållsutveckling som ett dokumentationsteam.

Nils lägger till: ”Jag kan faktiskt inte tänka mig att arbeta utan dessa Scroll Apps för Confluence längre. De sparar mig så mycket tid – tid som jag nu kan spendera på att skriva, istället för att kopiera och hantera mitt hjälpinnehåll manuellt.”

#7 – Confluence är idealiskt för agila miljöer

Likt många programvaruföretag följer K15t det agila utvecklingsparadigmet. Supportdokumentation, liksom produkter, utvecklas iterativt inom sprintar och releaser. Eftersom releasecyklerna blir allt kortare måste de tekniska skribenterna hålla jämna steg med varandra. Detta är endast möjligt om alla i teamet arbetar med samma verktyg, där de kan bidra med information och ge omedelbar feedback på hjälpinnehållet.

Nils beskriver sitt arbetsflöde för att släppa dokumentation. ”Jag arbetar med nästa version av vår dokumentation, och när våra utvecklare får ut produktreleasen så publicerar och uppdaterar jag helt enkelt mitt hjälpinnehåll med hjälp av Scroll Versions. Det tar bara några få klick.”

Slutsats: Fler användningsfall (och anledningar) att komma

Confluence började som en plattform för kunskapshantering och samarbete. Användarna hittade på sätt att utnyttja den plattformen för andra användningsområden och lockade till sig nya målgrupper. Och på samma sätt ökar antalet anledningar att använda Confluence för teknisk dokumentation dagligen – med varje ny Confluence-version och med varje ny app som kommer till Atlassian Marketplace.

Vilka anledningar har du att använda eller utvärdera Confluence för teknisk dokumentation? Och var ser du fördelarna i jämförelse med traditionella verktyg för hjälpförfattare? Lämna en kommentar och låt oss veta!

Om du har några frågor, tveka inte att skicka ett mejl till oss på [email protected] .