Hogyan írjunk egy műszaki tudásbázis a honlapjára, műszaki dokumentáció

Mi a szakmai tudásbázis és miért van rá szükség?

Tudásbázis - oly módon, technikai információ menedzsment, úgy, hogy lehet hivatkozni, és lehet osztani. Technikai tudásbázis jellemzően tartalmaz információt, hogyan kell használni a funkciók, folyamatok, illetve válaszokat a műszaki kérdésekre, és segít megoldani a problémákat.

Ha az üzleti van egy olyan alkalmazás, egy program vagy egy webhely egyedi funkciókat, majd néhány jó műszaki utasítások könnyebb lesz használni őket, hogy hasznos lenne, ha a különböző okok miatt:

• Ez egy információs tárház a problémákat, kérdéseket és megoldásokat. Ez azt jelenti, hogy ha a probléma megoldódott, a megoldás lesz írva, amely időt takarít meg a jövőben.
• Technikai lehetőségek és kihívások megmagyarázható amatőröknek - így mutatja be a megfelelő kiindulási pont, ahonnan indul, és az alkalmazottak és az ügyfelek.
• Segít az ügyfelek megoldani a problémákat, és választ találni a kérdésekre, anélkül, hogy lépjen kapcsolatba a technikai támogatást.
• Ez is segíthet a támogató személyzet válaszolni a kérdésekre gyorsan, ha a vevők még mindig benne foglalkozni.

A következő bekezdések szentelt hogyan kell felépíteni a tudásbázis és hogyan kell leírni a technikai részleteket, sikeres gyakorlati példákkal tapasztalat.

Hogyan strukturálni műszaki tudásbázis

A tudásbázis kevésbé lesz hatékony, ha az emberek nem találják meg, amit keresnek, ezért nagyon fontos, hogy milyen módon akkor strukturálja a tartalmat.

Válasszon egy könnyen megfigyelhető jelölést, amely lehetővé teszi az emberek, hogy az információt keresnek a lehető leggyorsabban. Osszuk a tartalom szakaszokra, és kérje a nyilvánvaló keresési módszert.

Példa: Base Groove tudás világos elrendezés és jól látható keresőmező segítségével a felhasználók megtalálják, amire szükségük van.

A jól megtervezett fejlécek segítsen az embereknek megtalálni, referencia és terjesztése cikkek a tudásbázis. Mindig használjon tiszta, közvetlen nyelvet, és próbálja, hogy tartalmazza a kulcsszavakat, amelyekre a felhasználók végezhet keresést. Használjon személyes megközelítés, hogy a felhasználók megértsék, hogy megtalálták a megfelelő cikket, kezdve a címe.

Példa: Hírek a Evernote érthető, összpontosított cselekvés és az írott nyelv a felhasználó.

formázás

Hozzon létre egy szabványos formátum, amely a következetesség és a könnyű olvasás. Használati, amennyiben lehetséges, általánosan használt szabályokat. Például beállíthatja, hogy így (melyeket a felhasználó a referencia) mindig el kell írásban a következők szerint:

Fájl> Mentés másként ...> Save as jpg

Hogyan kell írni a tartalmát a tudásbázis

Hozzon létre egy átlátható folyamat számára, akik tele vannak a tartalmát a tudásbázis - ez segít abban, hogy új kérdések, problémák és megoldások mindig rögzítve. Magyarázat lehetőségek valószínűleg készült különböző, de a kérdések és problémák valószínűleg követik a standard méret három lépésből áll.

Nagyon fontos, hogy a problémákat. Győződjön meg róla, hogy a következő információkat tartalmazza:

a) Mi a probléma? Feltétlenül elég sok részletet a probléma leírását, hogy az emberek tudják, hogy megtalálta pontosan az a gond, hogy a szembe.

b) Miért történik ez? Magyarázza el, mi okozta a hibát, és adja meg a lépéseket, akkor vegye annak kezelésére.

c) Honnan tudom, ha én is ugyanaz a probléma? Néhány információ, hogy esetleg szeretne venni ezen a ponton - a hibaüzenet, illetve a pontos ismert körülmények, melyek a problémát.

Ezután fesse át a választ arra a kérdésre, illetve megoldani a problémát. Ha a döntés komplex bontani könnyen megvalósítható lépések, kifejtve, minden szakkifejezés.

Példa: Wistia tartalmazza annak tanúsítvány screenshotok.

Azt reméljük, hogy a legtöbb olvasó megtalálja az információkat, amit keres, vagy megoldja a problémát, de azok, akik azt nem működik, meg kell ajánlani a kiutat. Ahol kérheti támogatást, ha a megoldás nem működik? Ha az embereknek szükségük van a kapcsolatfelvételre, hogy ezt a lehetőséget nyilvánvalóvá. Ez is egy jó ötlet, tegye linkek hasonló vagy ezekkel összefüggő kérdésekkel, ez segíthet megoldani a problémát, mielőtt hívja a helpdesk.

Tippek műszaki írás

Használjon egyszerű nyelvezetet is, ha az írás bizonyos szövegeket a felhasználói bázis. Senki nem akar időt átgázolni szakzsargont, mindannyian szeretnénk megoldást találni a problémára a lehető leggyorsabban.

Írj egy képernyőolvasó

A következők szerint tanácsot írásban FAQ. meg kell írni tartalom tudásbázis könnyebb képernyőolvasó. Ne írjon egy nagy blokk, összetör tartalom alkatrészek egyszerű beolvasási olvasás.

Példa: Basecamp megtöri a cikkek a fénynek szkennelés lépései.

Korrektúra és tesztelési megoldások

Következtetés - tartja a tudásbázis a mi lábujjak

Is, akkor lehet, hogy vajon:

1. 111 források ötletek a blog Corporate blog - a mai világban ez egy szükséges eszköz.
2. 13 statisztikai tényeket szövegírás az üzleti A cikk bemutatja a statisztikák összeállítása a különböző szempontokat és szövegírás.
3. Honlapfrissítés Kedves barátaim! Örömmel jelentjük be, hogy a mai napon a honlapunkon kezdődik.
4. Ahogy kommunikátorok segítségével Doc-To-Help Mostanában üzletünkben lehetősége van arra, hogy megvásárolja a terméket létrehozni.
5. Új szolgáltatások a dokumentáció Mától, akkor használhatja az új szolgáltatásokat segítséget.