Hallo, Ich möchte gerne ein Projekt von mir gut dokumentieren und frage mich ob es dafür gute Vorlagen gibt zB für TeX oder Word. Am liebsten ist mir natürlich wenn es am Ende wie eine professionelle Bedienungsanleitung aussieht. Desweiteren habe ich in anderen Manuals oft gesehen, wie LCD Ausgaben abgebildet sind, weiss jemand mit welchem Programm solche Bildchen erzeugt werden. Für Tipps bin ich sehr dankbar :)
David P. schrieb: > wie LCD Ausgaben > abgebildet sind Je nachdem, um welches LCD es sich handelt...7-Segment mit numerischen und alphanumerischen Zeichen kannst du relativ gut mit entsprechendem Font in Excel nachbilden. Auch DOT-Matrix-Symbole sind durch etliche Schriften vertreten - musste mal im Netz nach Fonts suchen.
Fuer LaTex hatte ich immer das folgenden genommen: ftp://ftp.rrzn.uni-hannover.de/pub/mirror/tex-archive/macros/latex/contr ib/lcd/example.pdf Gruesse, Richard
Das ist genau das was ich gesucht habe. Danke! Irgendwelche allgemeinen Vorlagen für Dokus bzw. Anleitungen?
Nein, habe leider keine Vorlage. Bin gerade aber dabei eine zu erstellen. Ist aber eher so ein Projekt fuer nebenbei, wird also bestimmt noch 2-3 Monate dauern. Wenn ichs nicht vergesse, werde ichs hier posten. Gruesse, Richard
Schreibe am besten nicht ein Word oder PDF sondern besser HTML Dateien für die Dokumentation. Daraus kann man entweder eine CHM erstellen, samt Inhaltsverzeichnis, Links usw. oder man kann die Dateien einfach auch ins Internet stellen. Ein mal schreiben und überall verwenden. Meine Doku mache ich immer so. Die CHM ist auch gleichzeitig die Hilfe für die EXE (F1-Taste). Ein HTML-Editor: NVU-composer Dem, mein Projekt: Beitrag "EleLa - Elektronik Lagerverwaltung"
@Markus: Super Einwand! Ich allerdings, der sehr viel mit LaTeX macht, wuerde empfehlen das ganze mit LaTeX zu erstellen. Kommt natuerlich drauf an, wie umfassend das ganze wird. Mit LaTeX kann man PDFs erstellen, sowie in HTML exportieren, allerdings sind die Einzeldaten nicht unbedingt fuer eine CHM geeignet. Falls nur CHM erforderlich sind, dann ist der Composer bestimmt ausreichend, sobald aber vielleicht auch eine Print Puplikation erforderlich wird, faehrt man mit LaTeX am Allgemeinen besser. Gruesse, Richard
Gast
#2369554
Zur Doku in professionellen Projekten nahmen wir Word. Lasten- und Pflichtenhefte gehören ja auch zur Doku. Word nahmen wir deshalb, weil diese Dokumente durch viele Abteilungen gingen, jede Abteilung da eine Bemerkung hinein schreiben konnte (Lastenheftumlauf), oder es mit dem Kunden zu Änderungen hin und her getauscht wurde (Pflichtenheft Version X.XX). Sowas, wo mehrere Abteilungen an der Bearbeitung des Dokumentes beteiligt sind, geht nur mit einem breit geläufigen Format, welches alle kennen. Der Chef z.B. wollte ja gelegentlich auch mal die Dateien öffnen, die auf einem Server lagen. Als Vorlage für ein neues Lastenheft nahm man wieder ein altes als Grundgerüst. Die Struktur und Inhaltsverzeichnis sind ja immer gleich, nur die Textinhalte ändern sich. Die Bedienungsanleitungen wurden auch mit Word gemacht. Und zählen meiner Meinung nach zu den besten, die ich bisher sah. Die Projektierer machten Kundenunterlagen mit einem anderen Programm. Den Namen weiß ich nicht mehr. Im Internet bekam man fertig so genannte "Shapes", wie z.B. eine Frontplatte mit Display.
Gast
#2369678
Docbook wäre auch so ein Kandidat. Die SuSE-Handbücher (sowohl gedruckt als auch online) waren damit geschrieben.
Antwort schreiben
Bitte melde dich an, um einen Beitrag zu schreiben.