fox78
Aktives Mitglied
Thread Starter
- Dabei seit
- 02.02.2004
- Beiträge
- 2.786
- Reaktionspunkte
- 369
Hallo zusammen,
ich würde mich freuen, wenn ihr mal meine Überlegungen zum Aufbau eines Dokumentes kommentieren könntet.
Dazu muß ich aber ersteinmal etwas weiter ausholen:
Ich verfasse derzeit ein IT-Handbuch für die neu gegründete Firma meiner Eltern. Bis jetzt kümmere ich mich neben meinem Studium darum und bin der einzige, der weiß, was er da macht.
Damit irgendwann einmal ein anderer SysAdmin diese Aufgabe übernehmen kann (oder andere Mitarbeiter, sollte ich z.B. einmal ausfallen), möchte ich nun systematisch den Aufbau, die Vernetzung, die verwendeten Programme und externen Dienstleistungen etc. pp. in einem LaTeX-Dokument beschreiben.
Das Dokument sollte so aufgebaut sein, daß sich Änderungen schnell und ohne großen Aufwand einpflegen lassen.
Bis jetzt besteht es aus drei Teilen:
- Einem Anwenderhandbuch, zugänglich für jeden Mitarbeiter, in dem nur auf besondere Dinge der Softwarebenutzung in der Firma eingegangen wird. Es wird also kein Pages-Handbuch neu geschrieben, sondern nur, welches Papierfach beim Drucken evt. für Spezialpapier ausgewählt werden soll etc.,
- Einem Handbuch zur IT-Systembeschreibung für SysAdmins, in dem alle relevanten Dinge zu den Rechnern, zum Netzwerk, zur verwendeten Software beschrieben sind,
- Und einem nur für die Geschäftsführung zugänglichen Teil, in dem sämtliche Login- und Zugangsdaten zu Rechnern und Internetdiensten verzeichnet sind.
Soviel zum Plan.
Ich rätsel nun schon seit einiger Zeit, wie ich das am besten praktisch umsetze.
Z.B. die getrennten Benutzergruppen für die drei Teile: Mitarbeiter bekommen z.B. nur einen der drei Teile zu sehen, da würde es irritieren, wenn in diesem Teil das erste Kapitel eine Nummer größer als 1 hat. Sollte man also in jedem der drei Teile die Kapitelnummern zurückzusetzen und jedesmal wieder bei Kapitel 1 anfangen?
Oder die häufigen Aktualisierungen: Damit man nicht jedesmal das gesamte Handbuch neu drucken muß, wäre es doch besser, die Seitennummerierung für jedes Kapitel neu zu beginnen?
Aber wie kann man dann mit den daraus resultierenden Seitenangaben - z.B. I-2-5 für Teil I, Kapitel 2, Seite 5 - noch gescheit arbeiten? Was sagt ihr Typographen dazu?
Seht ihr noch andere Lösungen für o.g. Anforderungen?
Soviel erstmal von mir, ich hoffe auf Eure Anregungen.
Grüße Michael
ich würde mich freuen, wenn ihr mal meine Überlegungen zum Aufbau eines Dokumentes kommentieren könntet.
Dazu muß ich aber ersteinmal etwas weiter ausholen:
Ich verfasse derzeit ein IT-Handbuch für die neu gegründete Firma meiner Eltern. Bis jetzt kümmere ich mich neben meinem Studium darum und bin der einzige, der weiß, was er da macht.
Damit irgendwann einmal ein anderer SysAdmin diese Aufgabe übernehmen kann (oder andere Mitarbeiter, sollte ich z.B. einmal ausfallen), möchte ich nun systematisch den Aufbau, die Vernetzung, die verwendeten Programme und externen Dienstleistungen etc. pp. in einem LaTeX-Dokument beschreiben.
Das Dokument sollte so aufgebaut sein, daß sich Änderungen schnell und ohne großen Aufwand einpflegen lassen.
Bis jetzt besteht es aus drei Teilen:
- Einem Anwenderhandbuch, zugänglich für jeden Mitarbeiter, in dem nur auf besondere Dinge der Softwarebenutzung in der Firma eingegangen wird. Es wird also kein Pages-Handbuch neu geschrieben, sondern nur, welches Papierfach beim Drucken evt. für Spezialpapier ausgewählt werden soll etc.,
- Einem Handbuch zur IT-Systembeschreibung für SysAdmins, in dem alle relevanten Dinge zu den Rechnern, zum Netzwerk, zur verwendeten Software beschrieben sind,
- Und einem nur für die Geschäftsführung zugänglichen Teil, in dem sämtliche Login- und Zugangsdaten zu Rechnern und Internetdiensten verzeichnet sind.
Soviel zum Plan.
Ich rätsel nun schon seit einiger Zeit, wie ich das am besten praktisch umsetze.
Z.B. die getrennten Benutzergruppen für die drei Teile: Mitarbeiter bekommen z.B. nur einen der drei Teile zu sehen, da würde es irritieren, wenn in diesem Teil das erste Kapitel eine Nummer größer als 1 hat. Sollte man also in jedem der drei Teile die Kapitelnummern zurückzusetzen und jedesmal wieder bei Kapitel 1 anfangen?
Oder die häufigen Aktualisierungen: Damit man nicht jedesmal das gesamte Handbuch neu drucken muß, wäre es doch besser, die Seitennummerierung für jedes Kapitel neu zu beginnen?
Aber wie kann man dann mit den daraus resultierenden Seitenangaben - z.B. I-2-5 für Teil I, Kapitel 2, Seite 5 - noch gescheit arbeiten? Was sagt ihr Typographen dazu?
Seht ihr noch andere Lösungen für o.g. Anforderungen?
Soviel erstmal von mir, ich hoffe auf Eure Anregungen.
Grüße Michael