Skip to content

dokumentation.md

Latest commit

 

History

History
37 lines (29 loc) · 2.81 KB

dokumentation.md

File metadata and controls

37 lines (29 loc) · 2.81 KB
Raw

Dokumentation

Pflichtkriterien

  • C01 Vollständigkeit

    1. Alle relevanten Schritte von der Ausgangslage bis zum Ergebnis sind für eine Fachperson nachvollziehbar beschrieben.
    2. Alle Hauptfunktionen des Produkts oder der Lösung sind präzise und verständlich erklärt oder dargestellt.
    3. Alle Endresultate sind gut sichtbar abgebildet und/oder verlinkt. Die Links funktionieren.

  • C02 Struktur & Inhalt

    1. Die Dokumentation weist eine logische und kohärente Struktur mit einer nummerierten Gliederung in Haupt- und Unterkapitel auf.
    2. Querverweise sowie Inhalts-, Abbildungs- und Tabellenverzeichnisse sind korrekt erstellt und ermöglichen eine interaktive Navigation.
    3. Es gibt keine Redundanzen und überflüssige Informationen.
    4. Alle verwendeten Fachbegriffe sind entweder im Kontext erklärt oder in einem separaten Glossar/Legende definiert.

  • C03 Sprache und Grammatik

    1. Die Sprache der Dokumentation ist fliessend, prägnant und zielgruppengerecht.
    2. Rechtschreibung, Interpunktion und Grammatik sind einwandfrei (keine oder nur vereinzelt kleine Schwächen).
    3. Die Inhalte sind alle sachlich korrekt, relevant und dem Zielpublikum (Fachpersonen) angepasst.

  • C04 Rechtliche Rahmenbedingungen

    1. Geltende Normen, Standards oder Best Practices werden bei der Umsetzung berücksichtigt und sind nachvollziehbar beschrieben.
    2. Relevante regulatorische Vorgaben (z. B. Datenschutz, Privacy by Design, Copy Rights) werden aufgeführt und eingehalten.
    3. Informationen zum rechtlichen Umfeld (z. B. Lizenzen) der Arbeit sind vorhanden und dokumentiert.
    4. Eine korrekte und rechtlich gültig unterzeichnete Eigenständigkeitserklärung ist vorhanden.

  • C05 Visuelle Gestaltung

    1. Die visuellen Elemente (Grafiken, Diagramme, Tabellen, Screenshots) sind verständlich. Sie ermöglichen eine einfache Interpretation und Informationsaufnahme.
    2. Die visuellen Elemente sind gut lesbar, mit ausreichendem Kontrast und angemessener Grösse (z. B. auf A4 lesbar).
    3. Es wird mit verschiedenen Abbildungs-Arten gearbeitet (z. B. Skizzen, Layouts, Screenshots, Stockfotos, Hintergrundbildern, Tabellen, Infografiken, Icons).
    4. Die Abbildungen weisen aussagekräftige Beschriftungen/Legenden auf, um den Inhalt zu erklären und zu kontextualisieren.

  • C06 Kommunikation & Nachvollziehbarkeit

    1. Die Kommunikation mit Stakeholdern und Auftraggebenden ist verständlich. Sie kann mittels Journal und Anhängen nachvollzogen werden.
    2. Feedback wird aktiv eingeholt (z. B. durch Feedbackbögen, Rückmeldungen im Team), sinnvoll berücksichtigt und im Anhang dokumentiert.
    3. Quellen, die Verwendung von KI, Abstimmung mit Stakeholdern und die Validierung der Anforderungen sind durch entsprechende Nachweise (z. B. Protokolle, E-Mails, Links) im Anhang oder im Fliesstext im Arbeitsjournal dokumentiert.