Kontakt

SOFTWARE

Softwaredokumentation erstellen lassen – Onlinehilfen, Handbücher & API-Doku

Die ZINDEL AG erstellt seit über 30 Jah­ren pro­fes­sio­nel­le Soft­ware­do­ku­men­ta­ti­on für Her­stel­ler von Soft­ware, Apps und SaaS-Lösun­gen – als kon­text­sen­si­ti­ve Online­hil­fe, Benut­zer­hand­buch oder API-Doku­men­ta­ti­on. Wir arbei­ten nach der MMFD-Metho­de (Mul­ti­me­dia­les Funk­ti­ons­de­sign), erfül­len IEC/IEEE 82079-1 und sind nach ISO 9001 und ISO 27001 (BSI – Bun­des­amt für Sicher­heit in der Infor­ma­ti­ons­tech­nik) zer­ti­fi­ziert, sowie nach ISO 17100 regis­triert – Ihre sen­si­blen Soft­ware-Assets blei­ben bei uns so sicher wie bei Ihnen selbst.

Die 3 wich­tigs­ten Fakten

  1. UX-Fokus statt PDF-Fried­hof: Moder­ne Soft­ware­do­ku­men­ta­ti­on hilft direkt im Nut­zungs­kon­text – nicht erst nach lan­ger Suche in einem Handbuch.
  2. Doku im Takt der Releases: Sin­gle-Source-Publi­shing, modu­la­re Inhal­te und Trans­la­ti­on Memo­ry hal­ten Online­hil­fen, Hand­bü­cher und Über­set­zun­gen effi­zi­ent aktuell.
  3. ISO 27001 schützt sen­si­ble Soft­ware-Assets: Source-Repo­si­to­ries, API-Specs und Archi­tek­tur­dia­gram­me wer­den mit klar gere­gel­ten Sicher­heits­pro­zes­sen verarbeitet.
Unter­stüt­zung anfragen

INHALTSVERZEICHNIS

  1. War­um soll­ten Sie Ihre Soft­ware­do­ku­men­ta­ti­on extern erstel­len lassen?
  2. Wel­che Soft­ware­do­ku­men­ta­ti­on erstel­len wir für Sie?
  3. Wie funk­tio­niert der Erstel­lungs­pro­zess bei ZINDEL?
  4. Wie schüt­zen wir Ihre sen­si­blen Software-Assets?
  5. Was kos­tet eine Soft­ware­do­ku­men­ta­ti­on – und wie sen­ken wir die Kosten?
  6. War­um ist ZINDEL der rich­ti­ge Part­ner für Ihre Softwaredokumentation?
  7. Fazit
  8. FAQ

Warum sollten Sie Ihre Softwaredokumentation extern erstellen lassen?

Vie­le Soft­ware­teams lagern Doku­men­ta­ti­on aus, wenn Release-Zyklen schnel­ler wer­den, inter­ne Res­sour­cen knapp sind oder meh­re­re Ziel­märk­te bedient wer­den müs­sen. Pro­duct Owner, CTOs und Lead Deve­lo­per wol­len kei­ne Ent­wick­ler­ka­pa­zi­tät in Hand­bü­cher bin­den, wenn die­se Kapa­zi­tät für Pro­dukt­ent­wick­lung, Bug­fi­xing und Road­map-The­men gebraucht wird. Zusätz­lich steigt der Com­pli­ance-Druck: Der Cyber Resi­li­ence Act gilt für Pro­duk­te mit digi­ta­len Ele­men­ten; sei­ne Haupt­pflich­ten grei­fen ab 11. Dezem­ber 2027.

ZINDEL unter­stützt Unter­neh­men unter ande­rem beim Out­sour­cing Tech­ni­scher Doku­men­ta­ti­on und fügt sich in bestehen­de Pro­zes­se ein.

Typi­sche Aus­lö­ser für Outsourcing:

  • Major-Release mit hoher Dokumentationslast
  • feh­len­des Metho­den-Know-how für MMFD, EPPO oder topic-basier­te Hilfe
  • Mehr­spra­chig­keit ab dem zwei­ten Zielmarkt
  • stei­gen­de Anfor­de­run­gen an Cyber­se­cu­ri­ty- und Compliance-Nachweise
  • Sup­port­kos­ten durch unkla­re Nutzerführung
Website ILS S1000D Grafik 2

Welche Softwaredokumentation erstellen wir für Sie?

Soft­ware­do­ku­men­ta­ti­on ist nicht ein For­mat, son­dern ein Sys­tem aus pas­sen­den Infor­ma­ti­ons­pro­duk­ten. Ob Sie eine Online­hil­fe erstel­len las­sen, ein Benut­zer­hand­buch Soft­ware erstel­len las­sen oder API-Doku­men­ta­ti­on benö­ti­gen, hängt von Ziel­grup­pe, Nut­zungs­si­tua­ti­on und Release-Modell ab.

For­matKlas­si­sches Hand­buch (PDF)Kon­text­sen­si­ti­ve Online­hil­fe (HTML5)
Auf­rufaußer­halb der SoftwareF1-Tas­te, Hil­fe-Icon, UI-Kontext
Such­ver­hal­tenInhalts­ver­zeich­nis, IndexVoll­text­su­che, kontextsensitiv
Update-Zykluspro Major-Releasekon­ti­nu­ier­lich, pro Sprint oder Release
Mobi­le-Eig­nungein­ge­schränktrespon­si­ve
Metho­desequen­zi­el­le BeschreibungMMFD, EPPO, topic-basiert
Typi­scher EinsatzOnboar­ding, Schu­lung, Compliance-Nachweistäg­li­che Anwen­dung, Self-Service-Support

Wei­te­re Out­put-For­ma­te sind:

Durch Sin­gle-Source-Publi­shing las­sen sich Print, Online­hil­fe, Video-Assets und Über­set­zun­gen aus einer kon­sis­ten­ten Daten­ba­sis pflegen.

Wie funktioniert der Erstellungsprozess bei ZINDEL?

Der Pro­zess beginnt mit einer Ana­ly­se von Ziel­grup­pen, Funk­ti­ons­um­fang und vor­han­de­nen Doku-Bestän­den. Dabei wird unter­schie­den, ob End­an­wen­der, Admi­nis­tra­to­ren oder Ent­wick­ler ange­spro­chen werden.

Im Kon­zept legt ZINDEL die pas­sen­de Metho­de fest. MMFD, also Mul­ti­me­dia­les Funk­ti­ons­de­sign, stan­dar­di­siert Tex­te, Bil­der und Vide­os nach kom­mu­ni­ka­ti­ven Hand­lungs­zie­len wie Anwei­sen, War­nen oder Beschrei­ben. EPPO, “Every Page is Page One”, ergänzt die­sen Ansatz für topic-basier­te Online­hil­fen, bei denen jede Hilf­e­sei­te eigen­stän­dig ver­ständ­lich bleibt.

In der Redak­ti­ons­pha­se ent­ste­hen Hil­fe­tex­te, Screen­shots, tech­ni­sche Gra­fi­ken, Erklär­vi­de­os und auf Wunsch Docs-as-Code-Inhal­te direkt im Repository.

Anschlie­ßend fol­gen Loka­li­sie­rung und Pfle­ge über Trans­la­ti­on Memo­ry, Ter­mi­no­lo­gie­ar­beit und abge­stimm­te Release-Prozesse.

Merk­satz: Mul­ti­me­dia­les Funk­ti­ons­de­sign legt für jede sprach­li­che Hand­lung in der Soft­ware­do­ku­men­ta­ti­on ein ein­heit­li­ches For­mu­lie­rungs- und Gestal­tungs­mus­ter fest. Das Ergeb­nis sind kon­sis­ten­te, norm­ge­rech­te und über­set­zungs­ef­fi­zi­en­te Hilfetexte.

Wie schützen wir Ihre sensiblen Software-Assets?

Der größ­te Ein­kaufs-Blo­cker bei exter­ner Soft­ware­do­ku­men­ta­ti­on lau­tet oft: “Wir geben unse­ren Quell­code nicht aus der Hand.” Genau hier ist ISO 27001 ent­schei­dend. Die Norm steht für ein doku­men­tier­tes Infor­ma­ti­ons­si­cher­heits-Manage­ment Sys­tem mit gere­gel­ten Zugrif­fen, Berech­ti­gungs­kon­zep­ten, Sicher­heits­pro­zes­sen und regel­mä­ßi­ger Über­prü­fung. ZINDEL ist zer­ti­fi­ziert nach ISO 27001 und ISO 9001 als Qua­li­täts- und Sicherheitsnachweis.

Für Soft­ware­pro­jek­te bedeu­tet das: Source-Repo­si­to­ries, API-Spe­zi­fi­ka­tio­nen, Archi­tek­tur­dia­gram­me und inter­ne Pro­dukt­in­for­ma­tio­nen wer­den zugriffs­be­schränkt und pro­jekt­be­zo­gen ver­ar­bei­tet. Ergän­zend bil­det die IEC/IEEE 82079-1 den Rah­men für struk­tu­rier­te Nutzungsinformation.

Kos­ten

Was kostet eine Softwaredokumentation – und wie senken wir die Kosten?

Die Kos­ten hän­gen vor allem von Funk­ti­ons­um­fang, Ziel­grup­pen, Spra­chen, Out­put-For­ma­ten und Update-Fre­quenz ab. ZINDEL nennt kei­ne Pau­schal­prei­se, weil ein SaaS-Admin-Hand­buch anders kal­ku­liert wird als eine kon­text­sen­si­ti­ve Online­hil­fe mit API-Doku und meh­re­ren Sprachfassungen.

Effi­zi­enz ent­steht vor allem durch:

  1. Single-Source-Publishing

    HTM­L5-Online­hil­fe, PDF und F1-Hil­fe aus einer Quelle

  2. Translation Memory

    wie­der­ver­wend­ba­re Über­set­zun­gen und kon­sis­ten­te Terminologie

  3. modulares Redaktionssystem

    Nur geän­der­te Modu­le wer­den nachgepflegt

  4. Release-nahe Pflege

    Doku­men­ta­ti­on wächst par­al­lel zum Pro­dukt statt nach­träg­lich unter Zeitdruck

Warum ist ZINDEL der richtige Partner für Ihre Softwaredokumentation?

ZINDEL ver­bin­det tech­ni­sche Redak­ti­on, Visua­li­sie­rung, Über­set­zung und Daten­si­cher­heit in einem struk­tu­rier­ten Pro­zess. Für Soft­ware­her­stel­ler zählt dabei nicht nur Text­qua­li­tät, son­dern auch die Fähig­keit, sich in agi­le Abläu­fe, bestehen­de Tool­chains und sen­si­ble Ent­wick­lungs­um­ge­bun­gen einzufügen.

Ver­trau­ens­si­gna­le:

  • über 30 Jah­re Erfah­rung in Tech­ni­scher Dokumentation
  • acht­fa­cher tekom-Doku­preis
  • ISO 9001, ISO 27001 und ISO 17100
  • tech­no­lo­gie­agnos­ti­sche Arbeits­wei­se mit Ihrem Redak­ti­ons­sys­tem, Trans­la­ti­on Memo­ry oder Docs-as-Code-Stack

Fazit

ZINDEL ist der exter­ne Doku-Part­ner für Soft­ware­teams, die Engi­nee­ring-Res­sour­cen ent­las­ten wol­len, ohne bei Quell­code, API-Specs oder Archi­tek­tur­wis­sen Abstri­che bei der Sicher­heit zu machen. Die Doku­men­ta­ti­on bleibt releas­e­fä­hig, nut­zer­zen­triert und übersetzungseffizient.

Sie wol­len Ihre Engi­nee­ring-Res­sour­cen aufs Pro­dukt kon­zen­trie­ren – ohne dass Ihre Soft­ware-Assets das Sicher­heits­ni­veau ver­las­sen? Spre­chen Sie mit unse­ren Spe­zia­lis­ten für Soft­ware­do­ku­men­ta­ti­on. ISO 27001-zer­ti­fi­ziert. Erst­ge­spräch kostenfrei.

Key Takeaways

Risikominimierung

Schutz vor Regress­an­sprü­chen durch rechts­kon­for­me Dokumentation.

Normerfüllung

Ein­hal­tung rele­van­ter EU-Ver­ord­nun­gen und Normen.

Kosteneffizienz

Durch moder­ne Redak­ti­ons­sys­te­me wer­den Kos­ten gesenkt und Effi­zi­enz gesteigert.

FAQs

Ein klas­si­sches Benut­zer­hand­buch ist sequen­zi­ell struk­tu­riert, voll­stän­dig und außer­halb der Soft­ware abge­legt – ide­al für Onboar­ding und Com­pli­ance-Nach­weis. Eine kon­text­sen­si­ti­ve Online­hil­fe ist in die Soft­ware ein­ge­bun­den und lie­fert per F1-Tas­te oder Hil­fe-Icon genau die Infor­ma­ti­on, die der Anwen­der im aktu­el­len Arbeits­schritt braucht.

Über Sin­gle-Source-Publi­shing und ein modu­la­res Redak­ti­ons­sys­tem wer­den aus­schließ­lich geän­der­te Modu­le nach­ge­pflegt. Auf Wunsch kann die Doku­men­ta­ti­on in agi­le Sprints ein­ge­bun­den und nach dem Docs-as-Code-Ansatz direkt im Repo­si­to­ry gepflegt wer­den. Über­set­zun­gen blei­ben über Trans­la­ti­on Memo­ry konsistent.

ZINDEL ist nach ISO 27001 zer­ti­fi­ziert. Das bedeu­tet gere­gel­te Infor­ma­ti­ons­si­cher­heits­pro­zes­se, doku­men­tier­te Zugriffs- und Berech­ti­gungs­kon­zep­te, pro­jekt­be­zo­ge­ne Ver­ar­bei­tung sen­si­bler Soft­ware­da­ten und regel­mä­ßi­ge Audits. Source-Repo­si­to­ries, API-Specs und Archi­tek­tur­dia­gram­me wer­den damit kon­trol­liert und NDA-kon­form verarbeitet.

ZINDEL arbei­tet mit MMFD, dem Mul­ti­me­dia­len Funk­ti­ons­de­sign. Die Metho­de stan­dar­di­siert sprach­li­che Hand­lun­gen wie Anwei­sen, War­nen und Beschrei­ben über Text, Bild und Video hin­weg. Ergän­zend eig­net sich EPPO für topic-basier­te Online­hil­fen, bei denen jede Sei­te eigen­stän­dig ver­ständ­lich bleibt.

Sie brauchen die Doku nicht neu zu erfinden.

Über drei Jahr­zehn­te Erfah­rung, ein spe­zia­li­sier­tes Team und zer­ti­fi­zier­te Pro­zes­se – damit Sie sich auf das kon­zen­trie­ren kön­nen, was Sie am bes­ten tun: neue Soft­ware, Apps und SaaS-Lösun­gen entwickeln.

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.

Kon­takt

Sie benötigen Unterstützung im Bereich Elektrotechnik?

Schrei­ben Sie uns über unser Kon­takt­for­mu­lar oder for­dern Sie Ihr indi­vi­du­el­les Ange­bot an.

Portrait Timo

Timo Zindel

Vor­stand
+49 40 530478-0

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

Weitere Geschäftsadresse
Basler Str. 115a
79115 Freiburg i. Br.
Deutschland

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

Erfahren Sie rechtzeitig von unseren Fachveranstaltungen und den aktuellsten Branchentrends.

Jetzt zum Newsletter anmelden.

* Angaben erforderlich

Intuit Mailchimp