10 Dokumentation - Universität Stuttgart
10 Dokumentation - Universität Stuttgart
10 Dokumentation - Universität Stuttgart
Sie wollen auch ein ePaper? Erhöhen Sie die Reichweite Ihrer Titel.
YUMPU macht aus Druck-PDFs automatisch weboptimierte ePaper, die Google liebt.
<strong>10</strong>.2 Benutzungsdokumentation<br />
ST I<br />
Form der Benutzungsdokumentation<br />
– Verwende aktive anstelle von passiven Formulierungen<br />
– Verwende keine langen Sätze, die mehrere verschiedene Tatsachen<br />
beschreiben<br />
– Verweise auf vorher gegebene Informationen nicht nur durch Angabe von<br />
Kapitelnummern, sondern erinnere an Titel und Inhalt des referenzierten<br />
Abschnitts<br />
– Nummeriere und tabelliere Aussagen<br />
– Komplexe Sachverhalte redundant aus verschiedenen Sichten<br />
beschreiben<br />
– Einschränkungen in der Weitschweifigkeit, Qualität vor Quantität<br />
– Definiere präzise alle verwendeten Begriffe<br />
– Verwende kurze Absätze (bis zu sieben Zeilen)<br />
– Verwende Haupt- und Unterkapitel<br />
– Vermeide Schreibfehler und Strukturierungsfehler, Qualität des Produkts<br />
wird an der Qualität der <strong>Dokumentation</strong> gemessen<br />
© 2013 IAS, <strong>Universität</strong> <strong>Stuttgart</strong> 465
Change language