TCO002 · Technische Kommunikation
Technische Dokumentation
Technische Informationen, mit denen Menschen arbeiten können.
Die Ausgangslage
Wissen ist vorhanden, aber über Dateien, Versionen und Köpfe verteilt. Anwender finden Zusammenhänge, Abläufe oder den gültigen Stand nur mit zusätzlicher Rückfrage.
Unser Ansatz
PreTeSo erstellt oder überarbeitet die vereinbarte Dokumentation für Ihr Produkt, System oder Ihre Dienstleistung. Aufbau, Begriffe und Querverweise richten sich nach der Zielgruppe und ihrer Aufgabe.
Das erhalten Sie
Technische Dokumentation gemäß abgestimmtem Umfang.
Vereinbarter Leistungsumfang
- Dokumentstruktur und Informationsbedarf festlegen
- Technische Inhalte erstellen oder überarbeiten
- Begriffe, Abläufe und Querverweise konsistent aufbauen
- Abgestimmten Dokumentstand im vereinbarten Format übergeben
Beispielhafter Aufbau
Beispiel: ein System nachvollziehbar beschreiben
Dies zeigt einen möglichen Dokumentaufbau. Inhalt und endgültiger Umfang richten sich nach Ihrer Aufgabe.
- Zweck und Systemübersicht
- Aufbau und Schnittstellen
- Vereinbarte Abläufe und Erläuterungen
- Referenzen und Dokumentstand
Ablauf
Von Ihren Unterlagen zum vereinbarten Ergebnis
Aufgabe klären
Zielgruppe, Zweck, Format und Lieferumfang vereinbaren.
Inhalte entwickeln
Das Material strukturieren und fachliche Fragen mit Ihrem Ansprechpartner klären.
Prüfen und übergeben
Die vereinbarten Inhalte abstimmen und den freigegebenen Stand übergeben.
Was PreTeSo von Ihnen benötigt
- Vorhandene Dokumente einschließlich Versionsstand
- Systembeschreibung, Zeichnungen und Prozessinformationen
- Zielgruppe, Verwendungszweck und fachlicher Ansprechpartner
Leistungsumfang & Konditionen
Projektpauschale
Den konkreten Preis erhalten Sie in Ihrem Angebot.
Was bestimmt das Angebot?
Dokumentarten, Systemumfang, Ausgangsmaterial, erforderliche Abstimmung und vereinbarte Detailtiefe.
Zuständigkeiten & Leistungsgrenzen
PreTeSo erstellt die vereinbarten Unterlagen und stimmt die fachliche Prüfung mit Ihnen ab. Sie stellen die Ausgangsinformationen bereit und geben technische Aussagen frei. Beiträge spezialisierter Partner werden im Angebot benannt und vereinbart.
Dokumentart und erforderliche fachliche Prüfungen werden vorab festgelegt. Risikobeurteilung, Konformitätsbewertung, Zertifizierung und die vollständige Erfüllung gesetzlicher Dokumentationspflichten sind damit nicht automatisch beauftragt.
Welche Dateien erhalten Sie?
Das Angebot legt fest, welche editierbaren Dateien und Exportformate Sie erhalten. Die Gestaltung folgt der vereinbarten Corporate Identity und Ihren Vorlagen.
Wie laufen Abstimmung und Lieferung ab?
Die Anzahl der Korrekturrunden und den Zeitplan vereinbaren wir nach Sichtung Ihrer Unterlagen. Änderungen außerhalb der Aufgabenstellung werden vor Beginn zusätzlicher Arbeiten in Umfang und Preis abgestimmt.
Beschreiben Sie Ihre Kommunikationsaufgabe.
Nennen Sie Anwendung, Zielgruppe und vorhandene Unterlagen. Gemeinsam klären wir das Ergebnis und erstellen ein Angebot für den vereinbarten Umfang.
Öffnet eine E-Mail mit einem kurzen, editierbaren Briefing.