Dokumentation mit DocBook

• About this group
• Forums

• Home
• Groups
• Dokumentation mit DocBook
• Forums
• Profiling
• Warum Profiling?

• 
  Klaus Ebner    Premium Member   Group moderator

  The company name is only visible to registered members.

  Warum Profiling?

  In einem Projekt wurde ein Blueprint einer Anwendungsarchitektur erstellt. Dieser Blueprint umfasst viele unterschiedliche Aspekte der Anwendungslandschaft und der benachbarten Systeme. In der Folge wurde dieses Dokument zur Basis des entstehenden Lastenheftes einer Ausschreibung.
  
  Um das zu erreichen kann man zwei Wege beschreiten:
  a) Man erstellt ein neues Dokument und kopiert nur die relevanten Informationen aus dem alten Dokument, und erweitert diese.
  b) Man erweitert die Informationen im alten Dokument und blendet die nicht relevanten aus.
  
  Lösung a) hat den entscheidenden Nachteil, dass Informationen doppelt sind, und damit u.U. auch doppelt gepflegt werden müssen. Ein weiterer Nachteil ist der Verlust des "Big Pictures" im neuen Dokument durch das Fehlen der nicht (Zielgruppen-)relevanten Themen.
  
  Wie funktioniert Lösung b)?
  In DocBook gibt es die Möglichkeit, nahezu alle Auszeichnungselemente mit Bedingungen zu hinterlegen. Dazu gehören vordefinierte Bedingungen mit denen man Sprache oder Betriebssystem festlegen kann (z.B. für technsiche Beschreibungen die sich bei unterschiedlichen Betriebssystemen unterscheiden). Daneben gibt es auch das Attribut "condition" welches frei belegbar ist. Dieses Attribut wurde in dem genannten Projekt genutzt. Jedes Kapitel und jeder Abschnitt bekam einen Wert in condition hinterlegt. Dabei wurden Abschnitte mit den Bedingungen "Einleitung", "Ziele", "Details", "Quellen", etc. bezeichnet, während Kapitel in Anwendungsblöcke geteilt ("Plattform A", "Plattform B", etc.).
  
  Die Erstellung eines Zielgruppenspezifischen Auschnittes besteht nun nur darin, bei der Erzeugung der fo Datei das Profiling so einzustellen, dass, z.B., nur die Beschreibungen der "Plattform A" und darin nur die Abschnitte "Einleitung", "Ziele" und "Quellen" generiert werden. Dies geschieht, bei Nutzung von xsltproc, durch den Parameter --stringparam profile.condition "PlattformA;Einleitung;Ziele,Quellen".
  
  Der Vorteil liegt darin, dass alle Informationen zusammen bleiben, und man sie dennoch bei der Erstellung der Dokumente so zusammenstellen kann, wie es die Zielgruppe erfordert.
  
  • 17 Dec 2004, 09:12 am
  Klaus Ebner wrote: > In einem Projekt wurde ein Blueprint einer Anwendungsarchitektur > erstellt. Dieser Blueprint umfasst viele unterschiedliche Aspekte der > Anwendungslandschaft und der benachbarten Systeme. In der Folge wurde > dieses Dokument zur Basis des entstehenden Lastenheftes einer > Ausschreibung. > > Um das zu erreichen kann man zwei Wege beschreiten: > a) Man erstellt ein neues Dokument und kopiert nur die relevanten > Informationen aus dem alten Dokument, und erweitert diese. > b) Man erweitert die Informationen im alten Dokument und blendet die > nicht relevanten aus. > > Lösung a) hat den entscheidenden Nachteil, dass Informationen doppelt > sind, und damit u.U. auch doppelt gepflegt werden müssen. Ein > weiterer Nachteil ist der Verlust des "Big Pictures" im neuen > Dokument durch das Fehlen der nicht (Zielgruppen-)relevanten Themen. > > Wie funktioniert Lösung b)? > In DocBook gibt es die Möglichkeit, nahezu alle Auszeichnungselemente > mit Bedingungen zu hinterlegen. Dazu gehören vordefinierte > Bedingungen mit denen man Sprache oder Betriebssystem festlegen kann > (z.B. für technsiche Beschreibungen die sich bei unterschiedlichen > Betriebssystemen unterscheiden). Daneben gibt es auch das Attribut > "condition" welches frei belegbar ist. Dieses Attribut wurde in dem > genannten Projekt genutzt. Jedes Kapitel und jeder Abschnitt bekam > einen Wert in condition hinterlegt. Dabei wurden Abschnitte mit den > Bedingungen "Einleitung", "Ziele", "Details", "Quellen", etc. > bezeichnet, während Kapitel in Anwendungsblöcke geteilt ("Plattform > A", "Plattform B", etc.). > > Die Erstellung eines Zielgruppenspezifischen Auschnittes besteht nun > nur darin, bei der Erzeugung der fo Datei das Profiling so > einzustellen, dass, z.B., nur die Beschreibungen der "Plattform A" > und darin nur die Abschnitte "Einleitung", "Ziele" und "Quellen" > generiert werden. Dies geschieht, bei Nutzung von xsltproc, durch den > Parameter --stringparam profile.condition > "PlattformA;Einleitung;Ziele,Quellen". > > Der Vorteil liegt darin, dass alle Informationen zusammen bleiben, > und man sie dennoch bei der Erstellung der Dokumente so > zusammenstellen kann, wie es die Zielgruppe erfordert.
• 
  Lars Trieloff

  The company name is only visible to registered members.

  Re: Warum Profiling?

  Die Erstellung eines Zielgruppenspezifischen Auschnittes besteht nun nur darin, bei der Erzeugung der fo Datei das Profiling so einzustellen, dass, z.B., nur die Beschreibungen der "Plattform A" und darin nur die Abschnitte "Einleitung", "Ziele" und "Quellen" generiert werden. Dies geschieht, bei Nutzung von xsltproc, durch den Parameter --stringparam profile.condition "PlattformA;Einleitung;Ziele,Quellen".
  Eine weitere Möglichkeit hätte darin bestanden, die Profiling-Stylesheets anzupassen, so dass über einen Parameter die auszuwählenden Abschnitte und über einen anderen Parameter die anzuzeigenden Produkte ausgewählt werden.
  
  Das Stylesheet würde bezüglich der Produkte weiterhin nur auf die condition-Attribute achten, wenn es um die Einbindung oder Ausschließung bestimmter Kapitel ginge, würde auf den title des Kapitels geachtet.
  
  • 05 Jan 2005, 12:40 pm
  Lars Trieloff wrote: > > Die Erstellung eines Zielgruppenspezifischen Auschnittes besteht nun > > nur darin, bei der Erzeugung der fo Datei das Profiling so > > einzustellen, dass, z.B., nur die Beschreibungen der "Plattform A" > > und darin nur die Abschnitte "Einleitung", "Ziele" und "Quellen" > > generiert werden. Dies geschieht, bei Nutzung von xsltproc, durch den > > Parameter --stringparam profile.condition > > "PlattformA;Einleitung;Ziele,Quellen". > > Eine weitere Möglichkeit hätte darin bestanden, die > Profiling-Stylesheets anzupassen, so dass über einen Parameter die > auszuwählenden Abschnitte und über einen anderen Parameter die > anzuzeigenden Produkte ausgewählt werden. > > Das Stylesheet würde bezüglich der Produkte weiterhin nur auf die > condition-Attribute achten, wenn es um die Einbindung oder > Ausschließung bestimmter Kapitel ginge, würde auf den title des > Kapitels geachtet.
• Post visible to registered members