Handbücher wollen erstellt werden

Es ist ja fast ein Klassiker, da haben wir mächtigen Funktionen in INVEP eingebaut, und dann muss das ganze auch noch dokumentiert werden. Diesmal betrifft es unsere in INVEP integrierte Programmiersprache OBAS. OBAS ist ein Basic-Dialekt, der als integraler Bestandteil von INVEP extrem weitreichende Automatisierungen ermöglicht. Das haben wir natürlich nicht (nur) für uns eingebaut, sondern wir möchten unseren Kunden die Möglichkeit geben, sich ihr INVEP selbst anzupassen. Das geht natürlich nur, wenn die Möglichkeiten und Funktionen entsprechend gut dokumentiert sind. Also sind wir jetzt dabei das Handbuch zur Automatisierung mit INVEP zu schreiben. Wie üblich, machen wir das mit LaTex, da man solche umfangreichen Anleitungen nicht mit Word schreiben kann.
Die Frage, die sich dabei stellt ist allerdings, wie weit sollen wir überhaupt gehen. sicherlich gehört das eine oder andere Beispiel in die Dokumentation hinein. Insbesondere bei den wissenschaftlichen Funktionen stellt sich jedoch die Frage, ob wir wirklich die mathematischen Formeln die die Grundlage für die Berechnungen bilden, ebenfalls in’s Handbuch schreiben.
Wie dem auch sein, das INVEP-Programmierer-Handbuch wird wieder mal ein sehr umfangreiches Handbuch, da wir auch hier eine maximale Transparenz für den Anwender herstellen wollen.

Dieser Beitrag wurde unter Datenanalyse, Programmerweiterungen abgelegt und mit , , verschlagwortet. Setze ein Lesezeichen auf den Permalink.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.