Documentație internă: tot ce trebuie să știți (sfaturi și tutorial)

Afacerea ta are nevoie de documentație internă? Și ce este documentația internă în primul rând?

Deși probabil că ești familiarizat cu ideea de a crea documentație pentru a-ți ajuta clienții să obțină mai multă valoare din produsele sau serviciile tale, documentația de înaltă calitate poate ajuta, de asemenea, afacerea și angajații să lucreze mai bine.

Acest tip de documentație orientată spre interior se numește documentație internă și o puteți folosi pentru a crește productivitatea, a păstra și a partaja cunoștințele și multe altele.

În acest ghid, veți afla tot ce trebuie să știți despre documentația internă, inclusiv următoarele:

• Ce este documentația internă
• Beneficiile documentației interne
• Cele mai bune practici pentru documentația internă
• Cum să vă creați propriul centru de documentație intern

Ce este documentația internă?

Documentația internă este o colecție structurată de proceduri, cunoștințe, bune practici și așa mai departe ale companiei dvs.

Pe parcursul vieții companiei dumneavoastră, compania dumneavoastră va acumula o mulțime de cunoștințe și expertiză. Documentația internă vă ajută să păstrați toate aceste cunoștințe colective într-un singur hub ușor accesibil.

Îl puteți folosi pentru a îmbunătăți productivitatea, a preveni pierderea cunoștințelor, pentru a integra noi angajați și multe altele.

Să descompunem câteva concepte cheie...

Documentație internă versus externă

Documentația internă și externă servesc ambele acelorași obiective de documentare a proceselor, explicarea modului de a face lucrurile, împărtășirea cunoștințelor cheie și așa mai departe.

Diferența cheie constă în cine este publicul țintă pentru acea documentație:

• Documentație internă – publicul țintă este angajații companiei dumneavoastră.
• Documentație externă – publicul țintă sunt utilizatorii, clienții, clienții și așa mai departe.

Practic – clienții, sau străinii în general, nu ar trebui să vă vadă niciodată documentația internă, dar angajații dumneavoastră se vor baza probabil pe documentația internă pentru a-și îndeplini munca.

Diferite tipuri de documentație internă

Am atins acest lucru puțin mai sus, dar există diferite tipuri de documentație internă, fiecare dintre ele pe care veți dori să le adaptați obiectivului său specific:

• Procesați documentația – veți dori să documentați cum să efectuați corect anumite sarcini. Aceasta ar putea include liste de verificare, tutoriale și așa mai departe. De exemplu, ați putea avea un articol despre „Cum să creați o nouă documentație internă”.
• Documentația proiectului – veți dori să documentați detaliile și progresul fiecărui proiect. Acestea ar putea include propuneri, cazuri de afaceri, rezumate ale întâlnirilor, calendare și așa mai departe.
• Politică/documentație de resurse umane – veți dori să documentați politicile importante, cum ar fi integrarea angajaților, politicile de vacanță, zilele de boală, retragerea angajaților și așa mai departe.
• Documentația echipei – fiecare echipă își poate crea propria documentație internă pentru cunoștințele și politicile specifice echipei. De exemplu, echipa dvs. de conținut ar putea documenta ghidul de stil al blogului și politicile pentru lucrul cu afișele invitaților.
• Documentație tehnică – dacă aveți o echipă de dezvoltare, aceștia vor dori să-și creeze propria documentație internă care explică ce se întâmplă în cod, ghiduri de stil, politici de testare QA și așa mai departe.

Beneficiile documentației interne: de ce merită efortul?

Crearea documentației interne necesită, fără îndoială, ceva timp în plus față de „doar să o faci”.

Deci, care sunt beneficiile documentației interne? Adică, de ce merită să investești timp și efort în crearea documentației interne?

Iată câteva dintre cele mai mari avantaje ale documentației interne:

• Promovați schimbul de cunoștințe – puteți încuraja angajații să împărtășească cunoștințele. În plus, angajații pot accesa cu ușurință cunoștințele pe care ceilalți angajați le-au împărtășit fără a fi nevoie să interacționeze direct cu persoana care partajează inițial de fiecare dată.
• Creșteți productivitatea – prin documentarea proceselor și detaliilor importante, vă puteți asigura că angajații nu rămân blocați în mod inutil, ceea ce vă crește productivitatea generală.
• Încorporați noi angajați mai eficient – ​​atunci când un nou angajat se alătură companiei dvs., aceștia se vor putea baza pe cunoștințele dvs. interne cumulate pentru a ajunge rapid la curent.
• Păstrați cunoștințele – la un moment dat, angajații cheie vor pleca, fie definitiv, fie din cauza vacanței/boală. Deținerea de documentație internă asigură că cunoștințele acelor angajați sunt încă păstrate și accesibile chiar și atunci când aceștia sunt plecați.

Cele mai bune practici pentru crearea documentației interne de calitate

Acum că știți ce este documentația internă și de ce este importantă, să începem să ne gândim la modul în care puteți să vă creați propriul centru de documentare internă.

Vom începe cu câteva bune practici generale de documentare internă și apoi vom acoperi procesul tehnic de creare a propriului hub.

• Implicați părțile interesate cheie – documentația internă nu ar trebui să folosească doar o abordare de sus în jos – este important să implicați angajații cheie la fiecare nivel. La urma urmei, acești angajați sunt adesea cei cu cunoștințele „în tranșee” pe care doriți să le păstrați. De asemenea, este posibil să doriți să numiți anumiți angajați ca curatori de conținut, astfel încât să existe un factor de decizie clar.
• Reutilizați orice documentație existentă - nu trebuie să vă construiți întreaga documentație internă de la zero, deoarece probabil aveți deja conținut existent ascuns în diferite locuri. Încercați să reutilizați acel conținut într-un singur hub central pentru a fi mai ușor de accesat.
• Fă-l ușor de accesat – vorbind despre ușurință de acces, vrei să te asiguri că hub-ul tău este ușor de răsfoit și de căutat. Folosiți categorii și funcții precum sugestiile de căutare instantanee pentru a ajuta angajații să îndrume către conținut relevant.
• Creați un ghid de stil pentru consecvență – dacă toată documentația dvs. utilizează formatare diferită, va fi dificil pentru oameni să obțină valoare de la. Pentru a evita acest lucru, creați un ghid de stil în avans și urmați-l pentru fiecare conținut.
• Includeți imagini, videoclipuri și GIF -uri – nu vă bazați doar pe text – inclusiv imagini, videoclipuri și alte media, cum ar fi GIF-urile, vă pot face conținutul mai util. De exemplu, atunci când documentați un anumit proces, puteți include imagini sau un videoclip care documentează procesul.
• Evitați supradocumentarea - în timp ce documentația internă prezintă o mulțime de beneficii, supradocumentarea poate provoca, de asemenea, frustrare și enerva angajații. Este important să găsiți un echilibru între documentarea detaliilor importante și împovărarea angajaților cu munca ocupată.
• Păstrați totul actualizat – procesele și cunoștințele dumneavoastră instituționale se vor schimba în timp, așa că este important să actualizați documentația internă pentru a ține pasul cu aceste schimbări. Din nou, poate fi util să numiți angajați ca părți interesate care sunt responsabili pentru actualizarea documentației interne în timp.
• Solicitați feedback de la angajați – amintiți-vă că documentația dumneavoastră internă este acolo pentru a ușura viața angajaților. Nu vă fie teamă să cereți feedback de la angajați, deoarece aceștia ar putea avea câteva idei grozave despre cum să vă îmbunătățiți cunoștințele interne.

Cum să vă creați un centru de documentație intern

Acum, pentru întrebarea finală – cum creați de fapt hub-ul în care toți angajații dvs. pot accesa resursele de documentație internă?

Ei bine, aveți trei opțiuni principale când vine vorba de software-ul bazei de cunoștințe:

• Utilizați software open-source precum WordPress și HeroThemes.
• Utilizați un instrument SaaS.
• Codați-vă propria soluție.

Deși s-ar putea să fim puțin părtinitori, credem că abordarea open-source cu WordPress are foarte mult sens din câteva motive:

• Aveți proprietatea deplină și controlul asupra documentației dvs. Documentația dvs. poate conține informații sensibile pe care nu doriți să le așezați pe serverul altcuiva (ca și în cazul unui instrument SaaS). Cu WordPress, vă puteți păstra toate datele și informațiile pe propriul server.
• Este încă foarte simplu . Dacă utilizați un plugin WordPress, cum ar fi Heroic Knowledge Base, puteți fi pus în funcțiune în foarte puțin timp, ceea ce este puțin probabil să fie cazul dacă vă dezvoltați propria soluție.
• Este rentabil . Abordarea WordPress este, în general, mult mai ieftină decât un instrument SaaS. Amortizat pe parcursul unui an, veți plăti, în general, mai puțin de 15 USD pe lună pentru articole nelimitate și utilizatori nelimitați.

Iată cum să creați un hub de documentare intern folosind WordPress și pluginul Heroic Knowledge Base.

1. Configurați o instalare WordPress

Pentru a începe, veți dori să creați o nouă instalare WordPress care să acționeze ca centru intern de cunoștințe.

Aveți două opțiuni pentru instalarea WordPress:

1. Puteți crea un site intranet care este accesibil numai din rețeaua locală a companiei dvs. Avem un ghid pentru crearea unui site intranet WordPress.
2. Puteți crea un site WordPress public care este accesibil de oriunde, dar restricționați accesul folosind o parolă și/sau conturi de utilizator pentru angajați. Există multe plugin-uri care vă permit să creați conturi de utilizator sau doar să restricționați întregul site printr-o singură parolă pe care o puteți partaja cu angajații.

Datorită popularității muncii de la distanță în zilele noastre, probabil că veți dori să optați pentru a doua abordare, astfel încât angajații să poată accesa documentația internă chiar și atunci când nu sunt la birou.

2. Instalați baza de cunoștințe eroică

Odată ce ați instalat WordPress, puteți adăuga pluginul Heroic Knowledge Base pentru a-l transforma într-un hub de documentare intern.

Heroic Knowledge Base este un plugin WordPress care adaugă funcționalitate completă a bazei de cunoștințe la WordPress. Include o serie de caracteristici pentru ca centrul de documentare intern să fie un succes:

• Sugestii de căutare instantanee pentru a ghida angajații către conținut relevant.
• Categorii nelimitate pentru a organiza conținutul după subiect, departament etc.
• Instrument de feedback încorporat, astfel încât angajații să poată oferi feedback despre articole.
• Gestionarea ușoară a versiunilor și a reviziilor prin sistemul de versiuni încorporat WordPress. Acest lucru este grozav pentru a vedea cum s-au schimbat articolele de-a lungul timpului (și pentru a anula modificările dacă este necesar).
• Analize încorporate pentru a vedea care este conținutul care îi interesează cel mai mult angajații. Puteți utiliza aceste informații pentru a vă rafina și optimiza documentația.
• Widgetul asistent de ajutor oferă o altă modalitate ușoară pentru angajați de a găsi documentația relevantă.

Odată ce achiziționați baza de cunoștințe eroică, o puteți instala la fel ca orice alt plugin WordPress. Veți obține apoi o zonă de setări ușor de utilizat, unde puteți configura totul despre baza de cunoștințe privind documentația internă:

Alternativ, puteți utiliza și tema KnowAll, care se ocupă de designul centrului de documentare, în timp ce include toate funcțiile din pluginul Heroic Knowledge Base.

3. Adăugați articolele de documentație

După instalarea pluginului Heroic Knowledge Base, sunteți gata să începeți să adăugați conținutul intern.

Cu Heroic Knowledge Base, puteți face acest lucru folosind editorul de blocuri WordPress flexibil.

Baza de cunoștințe eroică adaugă și câteva blocuri dedicate pentru a vă ajuta să vă îmbunătățiți documentația. De exemplu, puteți adăuga cu ușurință înștiințări sau avertismente pentru a evidenția informațiile cheie sau problemele de evitat:

De asemenea, puteți adăuga categorii nelimitate pentru a vă organiza conținutul.

Pentru a schimba ordinea articolelor și/sau a categoriilor dvs., veți obține interfețe speciale de tip drag-and-drop. Le puteți accesa accesând Heroic KB → Comandă articole sau Heroic KB → Comandare categorii :

Creați-vă baza de cunoștințe internă astăzi

În timp ce crearea documentației interne necesită un angajament de a investi timp în crearea de conținut, acea investiție va fi profitabilă atunci când veți putea păstra și împărtăși cunoștințele, îmbunătăți productivitatea și veți integra mai eficient noii angajați.

Pentru cel mai simplu mod de a vă configura centrul de documentare intern, puteți utiliza software-ul WordPress open-source și pluginul Heroic Knowledge Base.

Folosind WordPress și Heroic Knowledge Base, veți obține următoarele beneficii:

• Proprietate deplină și control asupra datelor companiei dvs., deoarece totul rămâne pe serverele dvs.
• Costuri mai mici, deoarece plătiți un cost fix redus pentru utilizare nelimitată.
• Simplitate, deoarece Heroic Knowledge Base oferă toate caracteristicile de care aveți nevoie, ceea ce elimină necesitatea de a codifica o soluție personalizată de la zero.

Configurați-vă centrul de conținut intern astăzi și veți beneficia în cel mai scurt timp.