Contao Open Source CMS > Contao-Forum

Zum englischen Forum

Index > Benutzertutorials > Redaktionshandbuch

Nina
Partner
Avatar
Beiträge: 1200
Märkische Heide, Deutschland
Ich hab hier zum Teil schon ein TL-Handbuch nur für Redakteure geschrieben. Also nicht wie man diverse Module, Seitenlayouts etc. aufbaut, sondern die klassische Anleitung für einen Redakteur wie er in Typolight die Standardfunktionen nutzt: News schreiben, Seiten mit Texten versehen, etc.

Da ich das jetzt weiter schreiben muss (für meine Kunden) und auch auf den aktuellen Stand der TL-Technik bringen will, möchte ich diesmal die Community mit einbeziehen. So habe ich mehrere Leute die prüfen ob meine Anleitungen korrekt formuliert sind. Dafür haben hier alle Zugang zu einem Handbuch für Redakteure und müssen nicht selbst sowas schreiben (das Wiki ist für Redakteure nur verwirrend, da dort eher für Admins geschrieben und erläutert wurde).

Ich frage mich aber, wie ich die Inhalte des Handbuchs veröffentlichen soll. Meine Vorstellung wäre ja ein Wiki, da man die ganzen Vorteile mit Querverlinkungen, Editieren, etc. nutzen könnte. Andererseits bräuchte ich davon einen PDF-Export für meine Kunden.

Hat jemand eine Idee wie ich sowas aufbauen könnte bzw. eine mögliche alternative Idee wie ich den Spagat zwischen "der Community zur Verfügung stellen", "der Community die Möglichkeit zum Berichtigen von etwaigen Fehlern geben" und "den Kunden als PDF geben" vollbringen kann?
2008-01-25 18:18
stefan-at-work
Partner
Avatar
Beiträge: 571
Bad Segeberg, Deutschland
Hallo Nina,

ich würde glaube ich in dem Fall die klassische Lösung wählen (pdf-download). Falls Du Hilfe benötigst, biete ich Dir meine Hilfe gerne an - zumal wir das Thema beim TL-Usertreffen auch auf der Tagesordnung haben. Vielleicht ergeben sich hier ja auch alternative Möglichkeiten.

Wenn Du möchtest, kannst Du mir Dein bisheriges Extrakt ja einmal mailen.

Gruss
Stefan
„Vier von drei Deutschen können nicht rechnen“
2008-01-25 18:39
ich würde ebenfalls meine Hilfe anbieten. Wie Stefan würde ich mich ebenfalls über ein Exemplar freuen. (damit ich weiß, wie ich wo helfen kann)
2008-01-25 19:56
Nina
Partner
Avatar
Beiträge: 1200
Märkische Heide, Deutschland
Na gut, dann schreibe ich das erstmal in Word weiter. Dieses Wochenende ist für mich großes Handbuch-Wochenende, da ich den neuen Stand nächste Woche für ein paar Kunden benötige.

Ich stell euch dann als kurzfristige Lösung erstmal die Worddatei hier zum Download ein, sobald ich die Ergänzungen vom Wochenende drin habe. Im Grunde kann sich die ja auch jemand herunterladen, einen Fehler ausbessern und dann selbst die ergänzte Worddatei wieder hochladen. Perfekt ist das wahrlich nicht, aber vielleicht wirklich erstmal die schnellste "Lösung".
2008-01-25 20:10
Fabster
Partner
Avatar
Beiträge: 1009
Wiesbaden, Deutschland
In Word gibt es doch die Funktion "Änderungen nachverfolgen". Ich würde mich z.B. anbieten, das Word-Dokument zu lesen, meine evtl. Änderungen bzw. Ergänzungen einzutragen. Mit "Änderungen nachverfolgen" kannst Du dann sehen, wo ich was ändern würde und kannst dann die Änderungen annehmen ode ablehnen. Was meinst Du?
Ein Tag ohne Lächeln ist ein verlorener Tag (Charlie Chaplin)
2008-01-25 20:15
FloB
User
Avatar
Beiträge: 706
Freiburg i. Br., Deutschland
Zum Word in PDF umwandeln: Da gibts sehr nette Druckertreiber, hab mir vorher Bullzip PDF-Printer installiert, sehr schönes Teil :).
2008-01-25 23:33
felixpfeiffer
Partner
Avatar
Beiträge: 830
Hannover, Deutschland
Hallo,

also ich denke es wäre wirklich toll, wenn es ein "allgemeines" Redaktionshandbuch geben würde.
Zum einen ist es für alle eine Arbeitsentlastung, da man nicht alles schreiben muss. Es würden nur Änderungen, wie CSS-Klassenangaben oder ähnliches, eingepflegt werden müssen.
Zum anderen kenne ich es aus meiner Sicht, dass ich mich mit dem Verfassen so eines Handbuchs sehr schwer tue.
Schreiben muss ich es natürlich trotzdem, doch wurde mein erster Versuch von einer Korrekturleserin als "nicht so richtig verständlich" in die Revision geschickt.

Von daher versuche ich gerne mich an einem Porjekt zu beteiligen.
Generell wäre es aber toll eine Art wiki-Lösung zu finden, die dann das flexible Zusammenstellen eines Handbuchs ermöglicht.

Gruß, Felix
2008-01-26 11:26
Ich schreibe in anderen Kontexten häufiger Handreichungen, die von anderen Personen kritisch korrektur gelesen werden. Hier hat sich folgende Methode bewährt:
- Ich schreibe den Text in Word (ggf. Konvertierung in pdf).
- Die Rohvorlage wird von den anderen Beteiligten gelesen.
- Die Anmerkungen werden getrennt von dem Text geschrieben und mir zugeleitet.
- Ich arbeite die Änderungen wieder ein.
- usw.

Warum haben wir uns nicht für das Wiki-Verfahren entschieden. Wichtiger als die Änderungen selbst sind u.E. die Begründungen. Die Rückmeldungen zu den einzelnen Abschnitten enthalten somit nicht nur Änderungsvorschläge sondern auch die Empfindungen des Lesers beim Lesen der Originalversion. Aus den Erläuterungen zu den Änderungsvorschlägen kann ich manchmal mehr herauslesen als aus den Änderungsvorschlägen selbst.

Für ein Lexikon finde ich das Wiki-Verfahren genial. Handbücher oder Anleitungen im Internet, die nicht als pdf-Datei zu Verfügung stehen, sind für mich dagegen ein Graus!

jpb

P.S.: Ich finde es großartig, dass Nina ein Handbuch schreiben wird! Danke im Voraus!
2008-01-26 12:37
Nina
Partner
Avatar
Beiträge: 1200
Märkische Heide, Deutschland
Bin brav am Schreiben ... Zwischenstand gibt es morgen abend hier als PDF zur freien Verfügung. Dann nehme ich gerne Änderungs-Anregungen entgegen.
2008-01-26 16:24
Ich freue mich schon!

Halte durch! Auch wenn es sicherlich manchmal etwas schwer fällt.

jpb
2008-01-26 16:35
planepix
Partner
Avatar
Beiträge: 2255
Stuttgart, Deutschland
Ich bin an dem Thema auch immer mal wieder dran und habe schon überlegt, ob ich eine Doku-Installation mache, in der ich alle wichtigen Core-Features integriere und dann davon ein Handbuch mache.

Bin nun gespannt was Nina geschrieben hat.

Wichtig fand ich bei bisher erstellten Handbüchern, dass der Kunde genau seine Website im Handbuch zu sehen bekommt.
all best / beste grüße
planepix
2008-01-26 20:52
Nina
Partner
Avatar
Beiträge: 1200
Märkische Heide, Deutschland
Anbei der aktuelle bisherige Stand des Handbuchs (hab nochmal ganz neu angefangen, da das bisherige auf eine bestimmte Kundenwebsite abgestimmt war).

Wie ihr sehen könnt, arbeite ich mich sehr detailreich voran und bemühe mich, die Anleitung auch für Nutzer zu schreiben, die noch nie mit einem CMS gearbeitet haben. Daher beschreibe ich erstmal die Dateiverwaltung und danach die grundlegende Logik von TL in Bezug auf Seiten / Artikel / Elemente, da diese Logik für die meisten Nutzer anfangs nur schwer verständlich ist.

http://www.ena-kundenportal.de/temp-date…dbuch_Redakteure.pdf

Als nächstes (ab morgen) gehe ich Stück für Stück voran und beschreibe wie man eine Seite anlegt, Artikel anlegt, beschreibe die Elementtypen, usw. Danach folgen dann einzelne Module aus dem TL-Core wie das Newsmodul oder der Kalender.

Ihr könnt euch sicher vorstellen, dass das eine ganze Menge Zeit in Anspruch nimmt. Ich werde also jeden Tag in meiner Freizeit ein paar Stunden daran schreiben und hoffe, dass ich in absehbarer Zeit fertig bin.

Dann gibt es eine abschließende PDF die Leo gerne (wenn er will) auf der TL-Website zum Download bereitstellen kann. Für alle die das Handbuch individualisieren wollen, hinterlege ich es hier im Forum dann auch als offene Word-Datei.

Für den ganzen Aufwand möchte ich dann nur, dass ihr im Handbuch den Hinweis beibehaltet, dass die 1er Version des Handbuchs von mir geschrieben wurde.
Zuletzt bearbeitet von Nina, 2008-01-27 00:57
2008-01-27 00:41
felixpfeiffer
Partner
Avatar
Beiträge: 830
Hannover, Deutschland
Hallo Nina,

ich bin begeistert. Das ist wirklich tolle Arbeit.
Eine gaaanze Kleinigkeit aber wirklich nur nen Tippfehler:
Seite 6 - zweiter Absatz - 'Geben Sie hier z.B. "gran_vanaria" ...'.

Ansonsten toll geschrieben und sehr gut verständlich - wie ich finde.

Ich bin gespannt, wie es weiter geht.

Wenn Du mir das Muster der Datei zukommen lassen würdest, könnte ich schon mal versuchen für die ContentElemente, die ich programmiert oder zusammengeschustert habe, ein paar Zeilen zu schreiben.

Gruß, Felix
2008-01-27 11:44
Ich bin beeindruckt! Besonders die Beschreibung der Seiten-Artikel-Element-Struktur mit der Korb-Analogie ist dir sehr gut gelungen.

Vielleicht solltest du darüber nachdenken, das Kapitel "Die grundlegende Logik hinter dem Aufbau von Seiten und Inhalten " (hier ist die in der Überschrift übrigens m.E. ein Fehler unterlaufen ("-inhalten")) vor das Kapitel "Die Dateiverwaltung" zu setzen.

Ich bin schon auf das nächste Kapitel gespannt!

jpb
2008-01-27 12:04
FloB
User
Avatar
Beiträge: 706
Freiburg i. Br., Deutschland
Hui, schon fertig gestaltet .. kann man mMn anders machen (sprich: erst Text, dann Layout), dann kann man mit Änderungen besser umgehen (v.a. bei der Seitenstruktur), aber gut ..

Ich würds auch Layouttechnisch etwas anders gestalten (Stichwort Übersicht, Inhaltsverzeichnis u.ä. - Mut zur Lücke!). Und die Grafik mit dem Korb ist zwar gelungen, würde aber die Teile umdrehen. Auch kann man am Anfang noch allgemeine Erläuterungen einbauen (z.B. "www.deineseite.tlg ist die entsprechende Domain mit TL").

Durchgelesen habe ich es mir noch nicht, aber das ist mal ein erster Eindruck.

Arbeitest du mit Formatvorlagen? Kannst du die original Worddatei mal zur Verfügung stellen? Ich möchte layouttechnisch mal etwas ausprobieren.

Sonst siehts schonmal sehr gut aus!
2008-01-27 13:08