Kontakt

Software

Jetzt anfra­gen

Technische Dokumentation für professionelle Software

Soft­ware wird immer kom­ple­xer, ihr Auf­bau ist oft modu­lar, ihre Funk­tio­nen las­sen sich indi­vi­du­ell kon­fi­gu­rie­ren, noch dazu lässt sich die Bedien­ober­flä­che an die jewei­li­gen Bedürf­nis­se anpas­sen. Anders als Hard­ware, die unver­än­der­bar ist, ist Soft­ware maxi­mal fle­xi­bel. Die­se Kom­ple­xi­tät und Fle­xi­bi­li­tät macht die Beschrei­bung einer Soft­ware nicht gera­de ein­fach. Es ist kaum mög­lich, die Struk­tur einer Soft­ware in einem klas­sisch struk­tu­rier­ten Benut­zer­hand­buch abzu­bil­den. Ver­sucht man es den­noch, ver­liert man sich in vie­len Kapi­tel­ebe­nen, mit der Fol­ge, dass die Infor­ma­tio­nen nur schwer gefun­den wer­den kön­nen. Ande­re Lösun­gen sind gefragt.

Nut­ze­rin­nen und Nut­zer wol­len wis­sen, was die Soft­ware kann, sie möch­ten das gro­ße Gan­ze ver­ste­hen und die Beson­der­hei­ten erfah­ren. Nicht alle Funk­tio­nen und Optio­nen sind auf den ers­ten Blick ersicht­lich, man­ches ver­steckt sich in ande­ren Ebe­nen, in Kon­text­me­nüs oder Dia­log­fens­tern. Auch Abhän­gig­kei­ten sind nicht offen­sicht­lich, etwa wenn sich die Ein­stel­lung für einen Para­me­ter auf ande­re Para­me­ter aus­wirkt. All das muss beschrie­ben wer­den, und zwar so, dass es schnell gefun­den wer­den kann.

Was wir konkret machen

    • Egal ob gro­ßes Soft­ware­pa­ket oder klei­ne App, unse­re Tech­ni­sche Redak­teu­re müs­sen abwä­gen, was die Doku­men­ta­ti­on leis­ten muss, ob ein klas­si­sches Hand­buch oder eine kon­text­sen­si­ti­ve Online­hil­fe mehr Nut­zen ver­spricht. Manch­mal ist auch ein Medi­en­mix sinn­voll: Schu­lungs­un­ter­la­gen für die ers­ten Schrit­te auf Papier und detail­lier­te Hil­fe­tex­te für Fort­ge­schrit­te­ne online.
    • Wir wäh­len die geeig­nets­te Metho­de für die Beschrei­bung aus: Schritt-für-Schritt-Anlei­tung ver­sus Funk­ti­ons­be­schrei­bung, Mul­ti­me­dia­les Funk­ti­ons­de­sign (MMFD) ver­sus Every Page is Page One (EPPO), sequen­zi­el­le Beschrei­bung ver­sus Hypertext.
    • Wir erstel­len die Hil­fe­tex­te ziel­grup­pen­ge­recht, rei­chern die­se bei Bedarf mit Gra­fi­kenAni­ma­tio­nen oder Vide­os an.
    • Sobald die Soft­ware in einer neu­en Ver­si­on vor­liegt, aktua­li­sie­ren wir die Doku­men­ta­ti­on, damit nach jedem Update auch die Doku­men­ta­ti­on up to date ist.

    Das ZINDEL-Plus

    Bei ZINDEL wis­sen wir, wie man Soft­ware­do­ku­men­ta­ti­on ver­ständ­lich schreibt und illus­triert. Ob sie bes­ser als Schu­lungs­un­ter­la­ge ver­teilt wird oder als Online­hil­fe ein­ge­bun­den wird. Unse­re Tech­ni­sche Redak­ti­on ist genau dar­auf spe­zia­li­siert. Unse­re Pro­jekt­teams set­zen sich z.B. zusam­men aus Tech­ni­schen Redak­teu­ren, Spe­zia­lis­tin­nen für Tech­ni­sche Illus­tra­ti­on, Exper­ten für die Gestal­tung und das Publi­shing sowie Über­set­zungs­ma­na­ge­rin­nen.

    Für die Erstel­lung der Soft­ware­do­ku­men­ta­ti­on set­zen wir moder­ne Redak­ti­ons­sys­te­me ein, damit schon die nächs­te Anlei­tung güns­ti­ger wird. Für die Über­set­zun­gen nut­zen wir ein Trans­la­ti­on-Memo­ry-Sys­tem, um die Über­set­zungs­kos­ten mit­tel­fris­tig zu sen­ken.

    Unsere Leistungen:

      • Soft­ware­do­ku­men­ta­ti­on
      • Ter­mi­no­lo­gie­ar­beit im Deut­schen und in Fremdsprachen
      • Publi­ka­ti­on in ver­schie­de­nen For­ma­ten (z.B. PDF für den Druck oder das Web, HTML5 für Onlinehilfen)
      • Exper­ti­sen zu bestehen­der Softwaredokumentation
      • Fach­über­set­zun­gen in alle Spra­chen und Lokalisierung
      • Tech­ni­sche Illus­tra­tio­nen und Gra­fi­ken (z.B. SVG-Grafiken)
      • Erklär­fil­me und Instruktionsvideos

      Darauf können Sie sich verlassen

      • Know-how von 30 Spe­zia­lis­ten sowie über 30 Jah­re Erfah­rung und Innovation
      • Umset­zung rele­van­ter Richt­li­ni­en und Nor­men wie IEC/IEEE 82079-1 und ANSI Z535
      • Zer­ti­fi­ziert nach ISO 9001, regis­triert für ISO 17100, prä­miert mit 8 tekom-Dokupreisen

      Sie brau­chen die Doku nicht neu zu erfinden.

      Nut­zen Sie unse­re erfahrung

      Bereit mit uns loszulegen?

      ZINDEL AG - Technische Dokumentation
      Tangstedter Landstraße 83
      22415 Hamburg

      Telefon: +49 40 530478-0
      E-Mail: info@zindel.de