AusSo verpacken Sie Ihr LaTeX-PaketLernprogramm:
„Die wichtigen Teile eines Pakets sind der Code, die Dokumentation des Codes und die Benutzerdokumentation.“
Was ist der Unterschied zwischen der Dokumentation des Codes und der Benutzerdokumentation?
Antwort1
Nun, trotz allem hat jjdb genau ins Schwarze getroffen mit:
Benutzerdokumentation = Benutzerhandbuch, Dokumentation des Codes = Programmierhandbuch
Ich versuche, etwas poetischer zu sein:
Das Benutzerhandbuch ist, wie der Name schon sagt, für den Benutzer bestimmt, also für denjenigen, der hinter dem Computer sitzt und Ihren Code verwendet, um zu tun, was er tun muss.
Der Dokumentationscode ist Teil der bewährten Vorgehensweisen, die ein Programmierer befolgt, um den Überblick über seine Arbeit zu behalten, um klare Nachrichten für jeden zu hinterlassen, der den Code berühren möchte, und um einen klaren Verstand zu bewahren (insbesondere, wenn er nach längerer Nichtinteraktion mit dem Code zurückkommt).
Grundsätzlich sollte die Benutzerdokumentation so ausführlich wie möglich sein, da Sie nicht wissen, wie gut die Person, die sie liest, das Paket versteht (denken Sie daran, dass, wenn es sich um die erste Version handelt, sie höchstwahrscheinlich noch niemand zuvor gesehen hat). Die Codedokumentation sollte hingegen darauf ausgerichtet sein, zu zeigen, was Ihr Code tut und wo er dies tut, damit etwaige Änderungen so einfach wie möglich vorgenommen werden können.