Nochmal Technische Doku...

Jan 21, 2014 479 Replies

Hallo NG,


Ich stehe hier nach wie vor vor der Aufgabe, technische Rohdokumentation



Funktions-/Adresstabellen, auch Fotos, ...) mit weiteren Textbausteinen


Tabellen (bspw.Excel) und Bilder (Export ing JPG, BMP, Vektorformate), und



Sowas sollte doch mit TeX eigentlich gut gehen, oder?



aber noch nicht vorgedrungen.



Gibt es da gute Tutorials?



strukturieren? Dokumenten-Managementsysteme? Schnelle Einarbeitung, ob im Selbststudium per Tutorial, Webinar oder


Ansgar


*** Musik! ***

Ansgar Strickerschmidt ( snipped-for-privacy@arcor.de):

in entsprechenden Formaten abstellen, PDF, JPG (besser eps) oder was auch

Dokument angeben.

TeXmaker oder das Texstudio, erstelle ein Testdokument und probiere es aus.

formatting link
formatting link
formatting link

baut, mit Logo, Kontaktdaten usw. Diese verwende ich einfach immer wieder,

Gliederung und baue dort die Tabellen, Listings, Bilder ein. Um die Nummerierung, Verzeichnisse (Tabellen, Bilder, Listings, Inhalt) braucht man sich nicht

Rechne grobe 2 Tage mit Texmaker oder Texstudio, dann kannst Du diese Dokumente aus immer den gleichen Vorlagen erstellen und brauchst Dir

ganz anders aussieht. Die 2 Tage sind aber 'learning by doing', d.h. Du kannst auch schon ein Ergebnis haben.

73 de Tom
DL7BJ|DL-QRP-AG #1186|DARC OV I18|FISTS #15933|AGCW #2737|ARRL http://dl7bj.org http://hamqth.com https://twitter.com/dl7bj

"Ansgar Strickerschmidt" :

Klingt nach ziemlich viel Seitendesign - brauchste wohl eher ein Satzsystem - sowas wie Pagemaker, denk ich mal. Hast also viele Abbildungen und Fotos usw.

Kriegt man das mit Tex so gut hin? Wie arbeitet man bei sowas (20%

Wird da noch ein Satzsystem dahintergeschaltet? (Scribus fand ich ziemlich

letztens).

M.

Thomas 'Tom' Malkus :

sieht dann das (mehr oder weniger automatisch erzeugte) Druckbild noch gut aus? Wo rutschen da die vielen Bilder hin? Was macht man, wenn da nen quadratisches Bild hat und ein rechteckiges (hochkant und ein eins quer) und die da alle sinnvoll dargestellt werden sollen? Kann mir kaum vorstellen, das

M.

Matthias Weingart ( snipped-for-privacy@pentax.boerde.de):

das Deckblatt:

\begin{minipage}{0.4\textwidth} \begin{flushleft} \small \emph{Autor}\\ Thomas Malkus \includegraphics[width=5cm,scale=0.5] {logo.eps} \label{Bild1} \end{flushleft} \end{minipage} \begin{minipage}{0.4\textwidth} \begin{flushright} \small \emph{Version}\\ 1.00 vom \today \end{flushright} \end{minipage}

Links steht das Logo + Autor, rechts steht die Version mit Datum. (Logo eben eingebaut, normalerweise habe ich das oben auf der Seite)

Wenn ich per Makefile eine neue Version erstelle, bei der auch der

im Dokument.

73, Tom
DL7BJ|DL-QRP-AG #1186|DARC OV I18|FISTS #15933|AGCW #2737|ARRL http://dl7bj.org http://hamqth.com https://twitter.com/dl7bj

Naja, kommt drauf an, wer die "Kunden" sind. Wenn das ernsthaft technische

wichtig als die Einheitlichkeit. Und man braucht auch keine besonderen

oder auf einer extra Seite, oder was auch immer).

Sowas kann man IMHO auch in einem besseren Textverarbeitungsprogrammm,

auch LaTeX wenn man das mag.

IMHO ist dabei weniger wichtig welches Programm man verwendet, sondern

Standardeinstellungen die z.B. Word mittlerweile hat abweichen. Seit

Dokumentation im Netz besser geworden, einfach weil sich die neuen Vorlagen

/ralph

Matthias Weingart ( snipped-for-privacy@pentax.boerde.de):

nicht als JPG oder so.

Da muss man schauen, wie es aussieht. Wenn Bilder oder Grafiken wirklich anders gesetzt werden sollen, dann werden sie "zwangspositioniert", z.B. so oder auch mit minipage:

formatting link

73, Tom
DL7BJ|DL-QRP-AG #1186|DARC OV I18|FISTS #15933|AGCW #2737|ARRL http://dl7bj.org http://hamqth.com https://twitter.com/dl7bj

Ralph Aichinger ( snipped-for-privacy@pangea.at):

Ja, das stimmt. Seit Calibri sehen die Word Dokumente wesentlich besser aus.

73, Tom
DL7BJ|DL-QRP-AG #1186|DARC OV I18|FISTS #15933|AGCW #2737|ARRL http://dl7bj.org http://hamqth.com https://twitter.com/dl7bj

Nein nein keinesfalls - das geht *nur* in Tex. Wer sowas in word macht

SCNR

Eric.

Thomas 'Tom' Malkus :

dann auch noch die Option, das in OpenOffice zu schreiben und dann als Latex- File zu speichern ;-).

M.

...

Du meinst, als PDF speichern und das einbinden oder habe ich da bei OO

Verwirrt, Wolfgang

Wolfgang Kynast :

Bei OO gibt es Export to Latex2 und bib (braucht aber Java), LibreOffice hat es nicht. Inwieweit da verkorkste Word-Dokumente dann im Tex-Format

M.

*g*

die mir ggf. zuliefern, sich kollektiv in neues Werkzeug einarbeiten

das kann.

Ansgar

*** Musik! ***

Matthias Weingart ( snipped-for-privacy@pentax.boerde.de):

mit Lazarus auf dem Desktop. Die Bedienung und Funktion ist identisch und damit eigentlich auch die Dokumentation. Bis auf die Screenshots, die sind

Es ist schon eine feine Sache beim Erstellen der Softwarepakete nur ein

Screenshots austauscht, also die Dokumentation aus den gleichen Quellen

aber anderen Screenshots erstellt.

Skripten habe ich mir eine Umgebung gebaut, die sehr viel automatisch er- ledigt. Egal ob Versionsnummern, Screenshots, Versionsinfo usw., die Skripte

73, Tom
DL7BJ|DL-QRP-AG #1186|DARC OV I18|FISTS #15933|AGCW #2737|ARRL http://dl7bj.org http://hamqth.com https://twitter.com/dl7bj

Auf die Gefahr hin, jetzt einen "S*it Storm" auszuloesen, bei allem sollte man auch an anderes Personal denken. Was geschieht, wenn es mal was viel wird und Du musst Dir bei der Zeitarbeiterfirma fuer 2-3 Monate eine Hilfskraft besorgen? Was passiert wenn Dir mal was passiert und die Firma muss fuer ein paar Monate einen externen Ingenieur heuern?

Hier haelt man sich in Firmen daher meist an das gaengige. Office fuer die normale Doku und eine uebliche Desktop Publishng Software fuer Hochglanzkram. Weiss jetzt nicht was bei letzterem aktuell ist, MS-Publisher, FrameMaker oder PageMaker.

Gruesse, Joerg http://www.analogconsultants.com/

Joerg ( snipped-for-privacy@invalid.invalid):

Bei anderen Dingen sicher ein Problem, keine Frage.

wird und entsprechend installiert und konfiguriert ist, mit dem 2 Leute arbeiten und das jeglichen Text per Cut'n'Paste annimmt und selbst in das richtige Format per Knopfdruck bringt, brauchst Du max. Personal, das einen einfachen Editor bedienen kann. Wenn denn eine Person da ist, die diese Texte dann einpflegt.

Im Extremfall (auch mal bei einem Kunden gemacht) sendet jemand den Text per E-Mail und der Mailserver baut das Dokument zusammen und es kommt als

das Problem, sondern eher bei dem dann evtl. fehlendem Wissen um den Inhalt.

73, Tom
DL7BJ|DL-QRP-AG #1186|DARC OV I18|FISTS #15933|AGCW #2737|ARRL http://dl7bj.org http://hamqth.com https://twitter.com/dl7bj

Wenn man ohne Training jemanden von der Temp Agency heuern kann und derjenige sofort in der Lage ist, saubere Doku zu erstellen, ok. Was nicht geht ist tagelanges Anlernen.

Ich habe es anders erlebt. Man musste je nach Software bei der Temp Agency suchen, welche Kandidaten das schon koennen. Dabei spielen bereits Dinge eine Rolle, die fuer Dich und mich unbedeutend sind. Z.B. wo man was in den Pull-Down Menues findet. Kann auch sein, dass die juengste Generation eines Tages nur noch mit Ribbons umgehen kann und dann ... ... muss die Software solche haben.

Gruesse, Joerg http://www.analogconsultants.com/

Joerg ( snipped-for-privacy@invalid.invalid):

Funktionen in einem Pull-Down Menue zu finden, eine technische Dokumentation erstellen kann?

73, Tom
DL7BJ|DL-QRP-AG #1186|DARC OV I18|FISTS #15933|AGCW #2737|ARRL http://dl7bj.org http://hamqth.com https://twitter.com/dl7bj

Hallo,

Am 21.01.2014 17:12, schrieb Thomas 'Tom' Malkus:

Der Technische Redakteur soll gleich loslegen und keine Zeit mit der

einige Tage hinweg. Die Programme haben immer wieder Besonderheiten bei der Menustruktur die sich aus der reinen Logik her nicht ableiten lassen. Vergleiche mal Adobe Illustrator und Inkscape oder Photoshop

Auftraggeber nicht zahlen will/kann.

PS: Aus dem Grund tendiere ich bei Grafik gerne zu Freier Software.

etwas Zeit. Bei Schriften sollte man IMHO auch so vorgehen.

MfG

Uwe Borchert

Join the Discussion

Have something to add? Share your thoughts — no account required.

Didn't find your answer?

Ask the community — no account required