rst-basierte Entwickler-Dokumentation (PHP)

rst-basierte Anwender-Dokumentation

Beratung Software-Dokumentation für das ITZBund-Project ?Bundescloud-Wiki? und "BC-Portal":

• Redaktionsleitfaden für Software-Dokumentation in Confluence und Drupal erstellen
• Templates  und Checklisten für Software-Dokumentation in Confluence erstellen

• Markdown-basierte API-Dokumentation
• Migrationsleitaden, Backup-Konzept, Betriebshandbuch zum Installieren, Konfigurieren und Warten der Microsoft SharePoint-basierten Lösung

• Word-Vorlage zum Erstellen von Bedienungsanleitungen gemäß EN 82079-1 und ANSI Z535
• Standardisierte Textbausteine für das teilautomatisierte Erstellen neuer Dokumente
• Spezifikation für eine VisualBasic-gestützte Automatisierung der Word-Dokumente 
• Spezifikation technischer Illustrationen unter Berücksichtigung der Standardisierung und Vereinfachung des Erstellens von Zeichnungen

• Vorlage für die Erstellung von Rohdokumentation durch die Ingenieure von Engie Fabricom erstellen
• Dokumentation entsprechend EN 82079-1 erstellen und prüfen (SCADA-System, Wasserversorgungs-Systeme, Feuermeldesystem, neben anderen Niederspannungsanlagen)

• Unterstützung beim Konzipieren und Umsetzen einer DITA-basierten Redaktionslösung für PDF- und Webhelp-Dokumentation für verschiedene Zielgruppen aus einer Quelle
• Erstellen eines Redaktionsleitfadens
• API-Dokumentation
• Endnutzer-Dokumentation
• Übersetzung ins Englische mit Trados SDL

Sie würden sich die mit DITA erstellten Dokumente gern einmal ansehen? Auf Anfrage erhalten Sie Dokumente oder Kontaktdaten für persönliche Referenzen.  

• Erstellen einer Pilot-Dokumentation auf der Basis von Markdown-Dateien mit Hugo, einem Generator für statische Web-Seiten: Entwerfen einer Gliederung und Navigation, Einbauen einer Suchfunktion, Anpassen von Stylesheets
• Erstellen eines Entwurfs für einen Redaktionsleitfaden
• Erstellen eines Quick Start-Guide und von Schritt-für-Schritt-Anleitungen für den Einstieg in Nutzung der IoT-Plattform.
• Unterstützung bei der Gestaltung von Benutzer-Oberflächen.

Zielgruppe: Mitarbeiter aller Bildungsschichten. Nur Alphabetisierung ist vorausgesetzt.

Ziel: Anwender emotional engagieren und zur Interaktion anregen, damit die Anwendung Nutzerdaten generieren und den Anwendern Feedback geben kann.

Herausforderung: Informationen so verständlich und eingängig gestalten, dass jeder Bandarbeiter sie verstehen kann, aber der Akademiker sich nicht langweilt.

Umsetzung:

• Motivierende UI-Texte für Endanwender entwickeln
  Sprachen: Englisch und Deutsch.
• Dramaturgie, Formulierungsmuster und Standards linguistisch messbarer Verständlichkeit für extern zugelieferte Texte entwickeln
  Ziel: Zugelieferte Texte fügen sich nahtlos in die Anwendung ein und sind konsistent gestaltet. Das stellt eine reibungslose User Experience sicher.
• Standard-Dokumentation für Administratoren erstellen
  Zielgruppe: Technisch versierte System-Administratoren und fachlich verantwortliche Spezialisten

Eine Übersicht über die Anwendung SAP Work-Life mit UI-Demo findet sich unter https://www.sap.com/swiss/products/work-life.html

• Finanzbuchhaltung (SAP FI) (Deutsch)
• Versicherungen (SAP FS-PM) (Englisch)
• Versorger (SAP IS-U) (Englisch)
     

• Betriebshandbücher und Konfigurationsleitfäden (Online-Manuals auf Deutsch und Englisch)
• User Assistance-Texte (Englisch) für Assistenten zum Identifizieren und Lösen von Problemen im laufenden Betrieb
     

Zielgruppe: Vertriebs-Mitarbeiter bei Versicherungen und Banken

Herausforderung: Konzepte der statistischen Datenanalyse intuitiv vermitteln

Hintergrund: Die Software erschließt Laien Funktionen der Datenanalyse, die von professionellen Datenanalysten mit anspruchsvollen Tools wie R oder SPSS genutzt werden

Umsetzung:

• Konzipieren und Erstellen von User Assistance (also Anleitungen, die unmittelbar die Interaktion mit der Software auf intuitive Weise lenken)
• Quickstart Guide

Zielgruppe: Vertriebssteuerung

Herausforderung: Statistische Auswertungen zur Vertriebssteuerung lesbar machen: 

• Was sagen mir bestimmte KPIs?
• Warum sind sie für mein Unternehmen wichtig?
• Was muss ich tun? Bei welchen Parametern muss ich nachsteuern, um die gegebenen Ressourcen optimal einzusetzen?

Hintergrund: Business Intelligence liefert wichtige Aufschlüsse über Optimierungspotenziale in Geschäftsprozessen. 

Aber nur, wenn die Verantwortlichen

• den Sinn bestimmter KPI im Kontext der Unternehmensstrategie nachvollziehen können
• die individuellen Auswertungen und Kennzahlen lesen, verstehen und in Entscheidungen umsetzen können
    

• Prozessbeschreibungen
• Rollout Provider Manual
• Software-Dokumentation
• Wissensmanagement
    

Installations- und Bedienungsanleitung (auf Anfrage als Referenz erhältlich)
  

• Erstellen von Installations-, Betriebs- und Wartungsanleitungen als Musterdokumente (FrameMaker)
• Modularisierungskonzept für XML-basiertes Redaktionssystem
    

• Projektmanagement (MS-Project)
• Visualisierung, Analyse und Optimierung von Organisationsabläufen (CMapTools)