Produkt - Bewertungsraster konkretisieren

[MarkusTiede]

module-wseg/docs/slides/content/04/01.md

Lines 67 to 70 in c969f4d

	### Produkt (50 Punkte)
	- Umfang und Qualität, Dokumentation (30P)
	- (zusätzliche) Features & Styling (20P)

[MarkusTiede]

30

Umfang (3 x 5 : 15P)

• 1️⃣ : Running MVP: Front-End only (2 static sites)
• 2️⃣ : Frontend + Backend: Register, Login & first (own) CRUD: Read
• 3️⃣ : Backend: CRUD for 2 (linked) entities

Qualität (5 x 0 1 2 : 10P) - (3 self defined + 1 @joberkel + 1 @MarkusTiede ) - Quality Properties

• top-level property 1 :
• top-level property 2 :
• top-level property 3 :
• @joberkel :
• @MarkusTiede : https://quality.arc42.org/tag-operable/

Dokumentation (5 x 0 1 : 5P) - 4 Qualities + 1 Requirement

• https://quality.arc42.org/qualities/code-readability
• https://quality.arc42.org/qualities/code-complexity
• https://quality.arc42.org/qualities/installability
  • @MarkusTiede & @joberkel bauen und starten eure Projekte lokal
• https://quality.arc42.org/qualities/understandability
• https://quality.arc42.org/requirements/clarity-in-technical-documentation

20

2 (zusätzliche) funktionale Features / Schwerpunkte (self defined) (3 x 5: 15 P) - self defined : 4️⃣.1 & 4️⃣.2 & 4️⃣.3

2 funktionale Features - exemplarisch incl. e.g.

• Media (Bilder) Upload + Darstellung zB Profilbild
• ...
• 3rd party library integration
  • Mail-Versand
• 3rd party API Integration
  • Mail-Versand
  • Temperatur, Preise, Wechselkurse, ISBN Nummer, ...
• ...
• zweisprachige Anwendung
• Dark-Mode für das Frontend
• ...

1 Schwerpunkt - self defined - exemplarisch

• https://quality.arc42.org/qualities/inclusivity
  • https://quality.arc42.org/qualities/accessibility
• https://quality.arc42.org/qualities/interaction-capability
  • https://quality.arc42.org/qualities/usability
  • https://quality.arc42.org/qualities/user-experience
• https://quality.arc42.org/qualities/i18n
• ...

Styling (5P)

• 0 1 2 : https://quality.arc42.org/qualities/user-interface-aesthetics
• 0 1 : https://quality.arc42.org/requirements/configurable-ui-theme
• 0 1 : https://quality.arc42.org/requirements/appearance-requirements
• 0 1 : https://quality.arc42.org/requirements/user-interface-works-with-current-browsers

[joberkel]

Danke auch für deine erste Gewichtung!
Hier mal meine möglichen Qualitätskriterien sortiert nach Property (ohne bereits viele Example-Requirements aufzuführen):

• #reliable
  • https://quality.arc42.org/qualities/usability
  • https://quality.arc42.org/qualities/code-readability
  • https://quality.arc42.org/qualities/legibility
  • https://quality.arc42.org/qualities/correctness
  • https://quality.arc42.org/qualities/consistency
  • https://quality.arc42.org/qualities/installability
• #flexible
  • https://quality.arc42.org/qualities/composability
  • https://quality.arc42.org/qualities/independence
• #usable.
  • https://quality.arc42.org/qualities/convenience
  • https://quality.arc42.org/qualities/communicability
    • https://quality.arc42.org/requirements/expressive-error-messages
  • https://quality.arc42.org/qualities/self-descriptiveness
• #suitable
  • https://quality.arc42.org/qualities/functionality
  • https://quality.arc42.org/qualities/correctness
• Bonus on top:
  • https://quality.arc42.org/qualities/accessibility
  • https://quality.arc42.org/qualities/understandability
  • https://quality.arc42.org/qualities/access-control (jwt)
  • https://quality.arc42.org/requirements/appearance-requirements (responsive)
  • https://quality.arc42.org/qualities/modifiability (extend backend)

[MarkusTiede]

Zeigt die Stellen wo ihr auf Qualität geachtet habt einfach explizit

• Link in den Quellcode auf Funktion / Methode / Abschnitt / Klasse

Fokus auf 2 Features + Schwerpunkt

2do

• Folien für Montag - edd1f23
  • Beispiel für Line-Number geben: https://gitlab.ti.bfh.ch/dsl-student-projects/wseg-24-hs/sandbox/-/blob/main/README.md?ref_type=heads&plain=1#L5-11
• Readme-Section-Template

Aktualisiert die Datei README.md, welche im Wurzelverzeichnis eures Repositories liegt

Beschreibt so kurz wie nötig wozu und wie die App verwendet werden kann.
Dokumentiert wie das Projekt von einem Nutzer aufgesetzt werden kann. Beschreibt die Schritte von `git clone` bis zu `npm run develop` oder `npm run start`.
Dokumentiert ggf. von euch verwendete 3rd-Party Libraries. Das ist z.B. wichtig für neue Entwickler*innen.
Diese Anleitung gibt euch gute Anhaltspunkte: https://www.freecodecamp.org/news/how-to-write-a-good-readme-file/