Bewährte Methoden, Gute technische Dokumente erstellen

Version 2

    Wenn Sie ein FileMaker®-Entwickler sind, müssen Sie gute Kenntnisse im Schreiben technischer Dokumente haben. Sie müssen Benutzern, die nicht so technisch versiert sind wie Sie, komplexe Informationen vermitteln können. Selbst wenn Ihre längste Zeichenkette ein Tooltip mit zehn Worten ist, sollten diese so klar und präzise wie möglich sein. Vielleicht schreiben Sie keine Benutzerhandbücher für Ihre Lösung, dennoch sind Sie die beste Informationsquelle für den Autor der technischen Dokumente, der eventuell selbst kein Entwickler ist; daher müssen Sie ihm Ihr Wissen vermitteln können. Darüber hinaus ist es meist so, dass ein Entwickler nie mit einem Kunden spricht, selbst wenn der Kunde die Werbeabteilung am anderen Ende des Gebäudes ist. Je mehr Sie über die Zielsetzung und den Prozess des technischen Schreibens wissen, desto besser wird die Erfahrung insgesamt für Ihre Kunden und letztendlichen Benutzer sein. Geschulte und informierte Benutzer sind zufriedener. Sie vertrauen Ihrer Lösung und verstehen, was diese tun soll. Benutzer, die Ihnen vertrauen, geben Ihnen bessere Rückmeldungen, anhand derer Sie Ihre Lösung verbessern können. Das ist genau die Art von Feedback, das Sie erhalten und pflegen möchten. Alles beginnt mit ordentlicher, schriftlicher Kommunikation.

    Dieser Artikel bietet Ihnen:

    - Informationen zu den unterschiedlichen Typen von Dokumenten, die bei der FileMaker Entwicklung verwendet werden

    - Regeln für das Erstellen strukturierter Dokumente
    -
    Beispiele für guten und schlechten Schreibstil
    -
    Methoden zur Veröffentlichung, Verbreitung und Pflege technischer Dokumente

     


    Viel Spaß beim Lesen

     

    Das FileMakerteam Deutschland