Technische Doku: welches Werkzeug?

Hallo NG,

In dem Zusammenhang geht es auch darum, geeignetes Werkzeug neu

Folgendes sind die Rahmenbedingungen:

- Produkte sind vorrangig Single-Board Computer; von der Doku her etwa vergleichbar mit PC-Motherboards

aufgebaut ist

- Rohinformationen (Signale, Steckerbelegungen, Blockschaltbilder...) sollen in Tabellenform (bspw. Excel) oder als Pixel- oder Vektorbilder angeliefert und extern eingebunden werden (also nicht eingebettet, sondern als externe Datei verbleiben)

Dokument gehen

- Web-Publishing ist nachrangig, es soll eine Papier- bzw. PDF-Doku werden.

Bisher ist MS Word im Einsatz. An verschiedenen Stellen ist mir das aber

beste Software, mit der ich bisher zu tun hatte. Inzwischen ist das bei Version 10 - und wird seit 100 Jahren nicht mehr gepflegt und wohl auch nicht mehr verkauft. Adobe InDesign schiene mir brauchbar - da mag ich Adobes Lizenzpolitik und Abo-System aber nicht. TeX kenne ich zuwenig - ich weiss, damit kriegt man ein sehr konsistentes Satzbild hin, aber wie es da mit der Einbindung externer Dokumente aussieht: keine Ahnung.

auch zu wenig Erfahrung. Was gibt's noch?

Also:

verwaltet ihr Versionen und externe Dateien? Und: Gibt es irgendwelche Erfahrungen mit spezialisierten Schulungen?

Gruss

Ansgar

Xpost & fup2 de.sci.electronics

--
*** Musik! ***
Reply to
Ansgar Strickerschmidt
Loading thread data ...

Hallo,

Am 27.09.2013 12:59, schrieb Ansgar Strickerschmidt:

Fast, manchmal wird auf ein freies Office umgestiegen.

Gar nicht. :-(

Ich würde pdflatex aus TeXlive empfehlen. Dazu noch ein Makefile, welches man aber manuell pflegen müsste, und man kann die Versionen der eingebauten Dateien auch noch berücksichtigen. Aufwendig wird aber ggf. das Festlegen des Dateibaums. Da muss man Hirnschmalz investieren. Du hast auf oberster Ebene dokumentenübergreifende Daten (Impressum, Adressen, Haftungsausschluss ...) und dann die vielen projektbezogenen Dokumente. Dazu braucht man aber definitiv geübte LaTeX-User mit viel Erfahrung bzgl. solcher Arbeiten. Eine popelige Diplom- oder Doktorarbeit als Erfahrung langt da nicht.

Hier mal ein einfachster Aufbau, der für paar Projekte reicht:

./commons -> Disclaimer, Adressen, Formalkram ... ./template -> Eine komplette und gut gewartete Vorlage! ./project_01 -> einzelne Projekte: tex-Datei, Makefile ... ./project_01/includes -> Tabellen, modifizierte Std-Kapitel ./project_01/images -> äh? ja ...

Ich habe sowas mal privat gebastelt. Das waren paar 100 Seiten Notizen mit insgesamt fast 1k Bilder ... Man braucht da echt ein paar Anläufe bis man das System raus hat. So können Grafiken und Fotografien durchaus auch mal so was wie commons werden. Dann müssen diese raus aus den Projekten!

PS: Auch ganz sinnvoll ist eine Verschlagwortung aller Bilder und Grafiken sowie eine Schlagwortdatenbank. Die kann durchaus Plain Text sein, aber sie soll/muss vorhanden sein.

MfG

Uwe Borchert

Reply to
Uwe Borchert

Am 27.09.2013 12:59, schrieb Ansgar Strickerschmidt:

Mir fällt Scribus ein. Das habe ich bislang recht wenig verwendet, fand es stellenweise etwas umständlich, habe damit aber immer sehr brauchbare Resultate erzielt (PDF oder Druck). Was mir umständlich vorkam, erfordert möglicherweise nur bessere Kenntnis der Werkzeuge. Keine Ahnung für welche Betriebssysteme es das gibt.

Ich habe immer darauf geachtet, möglichst nichts mit MS Office zu tun haben zu müssen, habe auf Rechnern von Apple unter System 6 bis MacOSX gearbeitet, außerdem auf PCs von DOS 3.3 bis Windows XP sowie von SuSE-Linux 4.2 bis Debian 6.

Versionen: Händisch (Ordner kopieren, umbenennen ...) Externe Dateien: bekamen eigene Ordner, wenn nötig/möglich, wurde mit ext. Zulieferern die Benennung der Dateien abgesprochen.

Nein.

HTH

Gregor

Reply to
Gregor Szaktilla

In de.sci.electronics Ansgar Strickerschmidt wrote: [...]

Damit sieht es gut aus. Grafiken kann man recht problemarm einbinden (man will sie evtl. sinnvoll konvertieren), Tabellarische Daten lassen sich mit kleinen Scripten leicht in (La)TeX-Format umwandeln. Die ganze Erzeugung der Zieldokumente kann man mit make etc. gut automatisieren.

Ralf

--
Wenn man wie ich die 25 bereits erreicht hat, dann hat man doch bis auf 
Elterngewesensein, ein erfuelltes Leben und ein Leben schon alles gehabt 
;) 
                                     ? Urs [Ayahuasca] Traenkner in dasr
Reply to
Ralf Döblitz

SVN auf einem virtual Server bei 1&1, mit TortoiseSVN sogar für Nicht-Programmierer leicht anwendbar. Für Open Source Projekte seit kurzem auch git per GitHub, was ein nettes GUI-Programm hat (meine Repositories, teilweise selber aufgesetzt und woran ich mitarbeite:

formatting link
).

--
Frank Buss, http://www.frank-buss.de 
electronics and more: http://www.youtube.com/user/frankbuss
Reply to
Frank Buss

"Ansgar Strickerschmidt" schrieb:

Als ich zuletzt danach suchte, gab es Ventura nur noch als US-Version und recht versteckt, wurde aber noch verkauft (.com, nicht .de). Ich persönlich finde das Programm gradezu genial. Leider Windoze only.

Du solltest jedenfalls einen Test mit den Staroffice-Abkömmlingen machen (LibreOffice, Apache Openoffice). Wenn die Dokumenteusen (hier geschlechtsneutral verwendet ;) mit M$-Office schon umgehen können. Wobei mir aufgefallen ist:

LO ist öfter mal kaputtgefummelt und entwickelt sich in komische Richtungen, eher ein bis zwei Versionen hinter der aktuellen bleiben.

AO ist ähnlich stabil wie das Office als es noch von Sun kam, man muß aber auf neue Versionen (also auch ggf. nötige Fehlerkorrekturen) warten. Ein neues Release dauert.

Außerdem:

Für sehr große Dokumente mit vielen Einfügungen (Bilder, etc) schwö ren viele Leute auf FrameMaker. Der Anschaffungswiderstand ist aber enorm.

Es gibt DITA (nicht das Mädchen), s. Wikipedia. Wenn man viele Varianten und Versionen hat, wie etwa Maschinenhersteller für jeden Kunden eine abgewandelte Grundkonstruktion, sehr gut. Braucht aber spezielle Editoren, geschultes Personal und IMO Spezialisten für die Einführung, also ebenfalls hohe EInstiegskosten. Alles strikt XML, im Gegensatz zu Binärformaten unkaputtbar und in der Not mit jeden Editor zu bearbeiten. Könnte man von der NAtur und dem Erstaufwand mit TeX und drumrum vergleichen, allerdings ist TeX ein Satzsystem.

Scribus nannte hier jemand, das ist aber bei textlastigem Arbeiten mit detaillierten Formatierungswünschen nicht immer fit genug. Ansonsten eben OSS und viele Plattformen.

Versionsverwaltung ist besser xtern mit OS-Servern zu bewältigen (svn, ...). Dann kann man zumindest das Bearbeitungsprogramm wechseln, ohne gleich einen Datenbank komplett mit konvertieren zu müssen. Und man ist komplett frei im Schema, was bei Editor-seitiger Versionierung nicht immer stimmt (Du sprachst die Versionierung der Fremdinhalte an).

HTH irgendwie, Marc

Reply to
Marc Santhoff

SVN auf nem lokalen Server, (+tortoiseSvn unter Windows) verwaltet nicht nur die Software sondern auch alle andren Dateien, inklusive der Dokus usw.. In der praktischen Arbeit ist das fast wie auf dem Netzlaufwerk zu arbeiten, nur mit dem Vorteil, das man alles da hat - auch wenn man mal offline ist - und man auch mal nachschauen kann, wie die Datei vor 1 Jahr oder so aussah (wobei letzteres nur selten gebraucht wird) und man irgendwelche Änderungen kontrolliert den Kollegen freigeben kann. Man muss halt nur sehen, dass man seinen lokalen SVN-Tree immer mal aktualisiert - man sieht bei der Gelegenheit dann auch schön, was die Kollegen neu eingestellt haben.

Word oder seine OpenOffice-Ableger (ist mittlerweile recht kompatibel)

- damit kann dann auch mal nen Übersetzer was anfangen

Photoline (dt. Shareware 50Eur)

- für Prospekte und kompliziertere technische Dokus Das scheint zwar auf den ersten Blicke ein Photoshop-Ableger zu sein, kann aber mittlerweile auch sehr gut mit Vektoren, Texten und mehreren Seiten umgehen - wobei es schnell und simpel ist. Jedenfalls bleiben - im Gegensatz zu Word - meine Pfeile auf den richtigen Stellen in den Bildern und man kann auch mal nen PDF editieren bzw Dinge aus nem PDF rausziehen. Es erzeugt auch selbst PDF's - wobei man da auch gleich die PDF-Grösse selbst unter Kontrolle hat (liegt im wesentlichem immer daran, mit welcher Auflösung die BMP's ins PDF umskaliert werden). Wobei der Nachteil ist, das andere Leute das nicht haben, nen Übersetzer damit nix anfangen kann...

M.

Reply to
Matthias Weingart

...

Mehrseitiger? Frag mal in der entsprechenden Newsgroup (de.comp.text.tex) nach. Eigentlich geht das über includes ganz gut:-) Zumindest als ich das vor

7 Jahren zuletzt gemacht hatte.

Ich würde TeX bevorzugen. Was Ihr da kurzzeitig an einen LaTeXer zalt für eine Basisversion Vorlagen sollte mit den Lizenkosten komerzieller Programme abgedeckt sein (Nur so als Argument, falls da ein BWLer meint eure Arbeitstunden kosten nichts). Eigenpflege geht dann besser selber. Wenn ich mir den Krampf bei uns mit Word angucke... englischsprachige Dokumente, Zuliefere liefern die an mit Fig... und man will die weiterbearbeiten und kriegt außerhalb der Nummerierung Abbildung... nein Danke. Zum Glück krieg ich dafür Schmerzensgeld:-)

Olaf

Reply to
Olaf Schultz

Und so sprach Ansgar Strickerschmidt:

Du hast es schon genannt: (La)TeX.

- Problemlos versionierbar

- Abbildungen auf Textformat skalierbar, viele Abbildungen (Graphen) lassen sich direkt im Dokument erzeugen.

- externe Dokumente als PDF oder PS in einem Pfad bereitstellen und einlinken. Quelltexte und (csv-Formatierte) Tabellen lassen sich direkt einbinden.

- Firmenkopf extern bereitstellbar, und wird automatisch korrigiert, sobald das Dokument das nächste mal kompiliert wird.

- völlig Plattformunabhängig

Auf der Minus-Seite steht nur die Einarbeitung.

Roland

Reply to
Roland Ertelt

Firmengroesse? Ist in diesem Zusammenhang sehr wichtig.

Wenn es viele Stecker mit vielen Pins sind, wuerde ich das nicht mit Excel, sondern einer Database machen. Das hat eine Menge Vorteile. Beispiel: Zeige mir jetzt sofort eine komplette Liste aller Pins an allen Steckern, auf denen +5V liegt.

Ich hatte das bei unserer ersten Start-up Firma in HTML Form gemacht. Lief sauber, man konnte sich durch das ganze recht komplexe Projekt durchklicken. Bei der grossen Firma spaeter haben wir Agile als Doku System benutzt, was recht sauber lief. Das bindet den Einkauf, die Buchhaltung, ECO und so weiter mit ein.

Halte ich fuer riskant, aber was die dazu noetige Software wie Subversion und so angeht, ueberlasse ich das anderen.

Kann ich nicht nachvollziehen. Ich verwende MS-Word (und inzwischen manchmal auch OpenOffice, aber nur den "Write" Teil) seit 1989 fuer saemtliche Projekt-Doku. In vielen meiner Projekte ist behoerdlich eine lueckenlose "Design History" vorgeschrieben und das ist bisher stets ohne Mosern durchgewunken worden. Da waren fette Dokumente mit mehrseitigem Inhaltsverzeichnis bei.

MS-Word hat einen beinahe allesentscheidenden Vorteil: Es ist kompatibel zum Format dass in so ziemlich saemtlichen anderen Firmen und Zulassungsbehoerden ueblich ist. Wenn man Zulieferer oder Kunden oder gar beides hat, ist das extrem wichtig.

Hat sich nicht durchgesetzt.

Ich packe sowas seit der Erfahrung mit dem staendig abstuerzenden Reader nicht mehr an.

Das soll wohl gehen, aber koennen das auch die Firmen lesen und schreiben, mit denen Ihr so zusammenarbeitet? Wenn nicht, ist das ein harter Show Stopper.

Ist teilweise brauchbar. Der Word Processing-Teil voll, der Spreadsheet-Teil mit gewissen Einschraenkungen (beherrscht VBA nicht richtig), der Database-Teil ist IMHO unbrauchbar und inkompatibel.

Als Industriestandard? Nix ...

Yup.

Mit ueberlegter Directory-Struktur und Versionsbezeichnung in jedem File. Beispiel Master-Dokument fuer den fiktiven Kunden Wombat Enterprises, Inc.:

WEI074_a.doc -> Ist Rev A.

Wenn "Works in Progress" und fuer ein Meeting eine zu archivierende Zwischenversion raus muss:

WEI074_a_temp1.doc

Wenn in der Design History heute eine "Works in Progress" Milestone-Zwischenversion abgelegt werden muss:

WEI074_a_20130927.doc

Bei Kunden wird statt "WEI074" eine Geraete- oer Modulnummer vergeben. Das gilt aber alles nur fuer kleine Firmen, wie etwa mein Ingenieurbuero. Bie mehr als ein paar Leuten oder wo man sich nicht mehr absprechen kann, wer gerade an welchen File arbeitet, braucht man was groesseres wie etwa Agile (gibt noch viele andere).

Bei Agile hatten wir Schulungen mit je 8-12 "Schuelern" und mir brachten die was. Spaeter war ich dann in unsere Divisioon manchmal der Lehrer. Beim System, was die Muttergesellschaft davor hatte und bei meinem ersten AG zog ich mir das ohne Schulung rein.

--
Gruesse, Joerg 

http://www.analogconsultants.com/
Reply to
Joerg

Ansgar Strickerschmidt wrote on Fri, 13-09-27 12:59:

Wenn es ganze Seiten als PDF sind: trivial. Ganzseitige Graphiken als Jpeg oder PNG ebenso.

Schulung für Microsoftprodukte wird fast überall an Hoch- und Volkshochschulen auf Kosten der Steuerzahlerzahlers angeboten. Fast alles andere mußt Du selbst bezahlen. Für mich ist das nackte Korruption.

Reply to
Axel Berger

Bisher ist bei mir nur die Browser-Integration vom Reader abgestürzt und die sollte man aus Sicherheitsgründen sowieso dekativieren, sodaß ein PDF-Dokument immer in einem extra Fenster angezeigt wird. Andere Produkte, wie Photoshop oder Adobe Premiere für Videonachbearbeitung, sind bei mir noch nicht abgestürzt.

InDesign soll auch recht professionell sein. Habe es selber noch nicht verwendet, aber kenne Firmen die es erfolgreich einsetzen. Allerdings nur für Sachen wie Manuals usw. die an Kunden herausgehen, der Rest wird meist mit Word gemacht.

--
Frank Buss, http://www.frank-buss.de 
electronics and more: http://www.youtube.com/user/frankbuss
Reply to
Frank Buss

Bei mir ist der Reader selbst staendig abgestuerzt. Das waren auch Aufrufe von Dokumenten von meiner Festplatte. Dieser Murks hoerte fast "digital" auf, als ich auf Foxit umstieg. Foxit ist nur ganz selten langsam geworden oder eingefroren, aber auch das nur, wenn ich darin mehr als ein Dutzend fette Dokumente per Fenster offen hatte.

Endkunden-Doku wie Betriebsanleitungen und erst recht Verkaufsprospekte werden auch hierzulande mit nobler Desktop-Publishing Software erstellt. "Nein, ich haette da hinten noch gern einen ganz, ganz leichten Blaustich" und so. Rest ist wie gehabt Word, leider inzwischen oft im docx Format. Unter eingefleischten Ingenieuren und selbst in unserer Kirche ist das Format "Word-97 compatible" Usus.

--
Gruesse, Joerg 

http://www.analogconsultants.com/
Reply to
Joerg

ACK. Einarbeitung zugegeben nötig, aber danach sehr gute Ergebnisse. Kombiniert mit einem Makefile, welches evtl. nötige Konvertierungen der Quelldateien (Bilder, Tabellen ...) erledigt, und eine Versionsverwaltung (CVS, SVN, ...).

Als Ergebnis kommen PDF-Dateien heraus, die absolut saubere Vektorgrafiken eingebettet haben - z.B. perfekt lesbare Schaltpläne. Wenn ich sehe, was man da im Vergleich mit Word produziert, wird mir schlecht ...

Das hatte ich bei $AG[-1]. Neue Schaltplanversion in die Doku importieren: zwanzigmal (Grafik anklicken, delete, Einfügen, Grafik, aus Datei, dann rechtsklick, Eigenschaften, Skalierung eingeben) - Grrrr. Mit TeX: einmal "make" und gut ist. Die Seiten mußten so und so als EPS eingebunden werden, damit das hinterher in gescheiter Qualität im PDF landet.

cu Michael

Reply to
Michael Schwingen

Ich darf es leider nicht zeigen, da Kundenprojekt, aber am Montag wurde wieder ein 26-seitiges Dokument hier fertig. Text, saubere Graphik, Formeln, 3D-Skizzen, Tabellen, Bauteillisten, jedes Teil mit klickbarem Hyperlink zum Datenblatt, fuenf Seiten perfekt lesbare Schaltplaene, bis Pusemuckel zoom-faehig. Im Original sowie im erzeugten PDF-File. Produziert im ... Word-Format.

[...]
--
Gruesse, Joerg 

http://www.analogconsultants.com/
Reply to
Joerg

Am 27.09.2013 19:11, schrieb Joerg:

Zentral-/Filialdokumente scheinen mir mit jeder Version immer schlechter

viele. Wenn man nur mal ein paar hundert Seiten in _einem_ Dokument

Dokumentationssystem ist das eindeutig zu wenig. Wenn jedenfalls

Dazu der Murks mit verschiedensprachigen Abbildungen/Figures und der

Und wie wirken sich Versionierungen in untergeordneten Filialdokumenten aus?

Bernd

Reply to
Bernd Laengerich

Joerg schrieb:

formatting link

Amen!

Marc

Reply to
Marc Santhoff

Ja nun, es ist schon lange so, dass abgehangene Software oft besser ist als neue. Wie bei Rotwein. Ich benutze konkret Word 97 und Word 2000. Manchmal habe ich zwar Lizenzen fuer neuere Software, benutze aber die alten Versionen weiter, weil sie besser sind. I.d.R. weil sie weniger haeufig abstuerzen.

Ueber hundert Seiten hatte ich schon, ging problemlos. Ein Word Processor allein ist kein Dokumentionssystem, der ist fuer die Input-Seite da. Dazu braucht man eine Software oder ein selbstgestricktes System, welches Files sortiert, archiviert und so weiter. Ich kann mir kaum vorstellen, dass z.B. LaTeX sowas kann.

Abbildungen ineinanderklatschen? Wozu waere das gut? Mit dem Import selbst habe ich nie Probleme. Was mich nach dem (zwangslaeufigen) Umstieg auf Windows gewurmt hat war, dass Word 97 und folgende nicht mehr direkt HPGL importieren konnten. Mit Word 5.0 fuer DOS fluppte das so schnuckelig.

Was meinst Du damit? Vielleicht ist mein Deutsch dafuer zu rostig geworden.

Wenn Du mit untergeordnet z.B. die importierten Files und Bilder meinst, die bekommen bei mir immer ihre eigene Rev. Es ist durchaus in Ordnung, dass der Module Spec Rev D ein Bild einer Anlage der Version Rev B hat, weil sich daran seit den beiden letzten Rev-Levels nichts mehr geaendert hat. Bie Leiterplatten ist es schliesslich auch so.

--
Gruesse, Joerg 

http://www.analogconsultants.com/
Reply to
Joerg

Wir Lutheraner beten aber mit gefalteten Haenden :-)

Vor drei Wochen passierte der Graus: Wir bekamen eine neue Audio-Anlage mit einem fetten neuen Allen&Heath Mischpult. Juchheissa. Aber der Rechner wurde gegen einen Apple ausgetauscht ... Grmpfl!

--
Gruesse, Joerg 

http://www.analogconsultants.com/
Reply to
Joerg

Werkzeug der Wahl für Versionkontrolle ist git, ich habe da von source code über Texte bis hin zum digitalen Dokumentenarchiv (meist gescannte Dokumente) alles drin.

Lesen ist kein Problem, man kann bei LaTeX z.B. PDF hinten rausfallen lassen. Schreiben ist eher kritisch - das Dokumentenformat ist zwar plain text und somit mit jedem halbwegs brauchbaren Editor zu handhaben, aber man muß halt zumindest etwas LaTeX können dafür, und da wird es oft scheitern.

Man liest sich, Alex.

--
"Opportunity is missed by most people because it is dressed in overalls and 
 looks like work."                                      -- Thomas A. Edison
Reply to
Alexander Schreiber

ElectronDepot website is not affiliated with any of the manufacturers or service providers discussed here. All logos and trade names are the property of their respective owners.