Műszaki dokumentáció Több, mint használati utasítás ›Webírás magazin - a kiadástól
Az új termék bevezetésének számos lépése van. A terméket gondosan meg kell tervezni, és minden fejlesztési lépést gondosan meg kell vizsgálni. Amikor a termék elkészült és készen áll a piacra dobásra, a fejlesztőnek gondoskodnia kell arról, hogy gondosan elkészítse a termék műszaki dokumentációját. A jogalkotók részletes műszaki dokumentációt igényelnek a termék biztonságának és megfelelő működésének biztosítása érdekében. A műszaki dokumentációval nemcsak a termék felhasználójának segít, hanem megvédi cégét az esetleges jogi támadásoktól is. Ez csökkenti a felelősség kockázatát, és elkerüli a dühös ügyfeleket, akik manapság a közösségi médiában is szeretik kivezetni dühüket.
Belső és külső műszaki dokumentáció
A külső műszaki dokumentáció a vevőnek vagy a termék felhasználójának szól. Ennek célja annak biztosítása, hogy a felhasználó megfelelően beindítsa a terméket, és hogy bármilyen probléma esetén először elolvassa a dokumentációt. Általános szabály, hogy az ügyfél műszaki dokumentációját speciális szerkesztők írják. Ha a terméket nemzetközi piacon értékesítik, a szövegeket szakszerűen kell lefordítani az egyes országok megfelelő nyelveire. Például Európán belül ezek az angol, a spanyol, a lengyel és a svéd. A külső műszaki dokumentáció jobban ismert, mint kezelési útmutató, használati utasítás vagy felhasználói kézikönyv, a terméktől és a célcsoporttól függően.
Különösen fontos a dokumentáció készítésével kapcsolatos szakmai munka. A használt szaknyelv ellenére a felhasználónak kevés problémája lehet a kezelési utasítás megértésével. A szövegek érthetősége mellett természetesen be kell tartani a stílust és a nyelvtani szabályokat is. A minden termékhez mellékelt szabványos papír alapú dokumentáció mellett célszerű online változatokat biztosítani a vásárló számára. Ez hosszú keresést takarít meg a felhasználó számára, ha az eredeti utasítások elvesznek. Egy professzionális tartalomkezelő rendszerrel való együttműködés a dokumentáció elkészítésében számos előnnyel jár. A szerkesztők tökéletesen képzettek az ilyen szövegek írására, és magabiztosak írási stílusukban. Felismeri a fontos információkat, és hatékonyan összefoglalhatja dokumentumként. A külső írók használata időt és pénzt takarít meg. Ezenkívül biztos lehet abban, hogy a dokumentációt az összes általános irányelvnek és specifikációnak megfelelően hajtják végre.
vita
Feliratkozás a megjegyzésekre (RSS)
2 megjegyzés a következőhöz: "Műszaki dokumentáció: Több mint használati utasítás".
Számomra, mint egyetlen fejlesztő (szoftver), a dokumentumok bosszantó létrehozása a program (még egyszer) megtekintésének egyik módja a jövőbeli felhasználó szemszögéből.
Amennyire lehetséges, a dokumentáció készítésének fázisától származó ismereteknek képesnek kell lenniük a termékbe áramlására; mert gyakran csak akkor ismeri fel, ha azt szeretné, vagy meg kell magyaráznia a termékét egy laikusnak, hogy hol van a probléma, és mi az, ami túl bonyolult módon megoldódott.
A nagyobb vállalatoknak ezért visszajelzési lehetőségre van szükségük az utasításírótól a fejlesztőkig.
Vagy a lehető legkorábban be kell vonni a szerző álláspontját a fejlesztési folyamatba.
Csak nemrég tapasztaltam egy igazi mega-flopot, dokumentáció hiányában: vettem egy nagyszerű párologtatót/tartályt az e-gőzömhöz, de nem írták le, hogyan szabályozzák a folyadék kiáramlását és beáramlását. Az alkatrészt visszaküldtem, mert a tetején „bezárva” találtam - annak ellenére, hogy Topfillernek kellene lennie! Visszaszereztem az alkatrészt, és íme: ahol még minden zárva volt, hirtelen lyukakat láttam ... minden rendben?
Semmi esetre sem! A kitöltő lyukak a következő próbálkozáskor ismét eltűntek ... Röviden: hosszú időbe telt, mire a pályára léptem. Az alkatrésznek valóban ötletes mechanikája volt a beáramló lyukak kinyitására és bezárására. Sajnos nem magától értetődő és NEM DOKUMENTÁLT!
Eredmény: a terméket jelenleg eladják . biztos, hogy senki sem tud problémamentesen megbirkózni vele ...