Skip to content

fsfw-dresden/schulstick-tutorial-docs

Repository files navigation

Hier findest du Dokumentation zum

  • Schulstick (Quellen, Download, Installation, Booten, Starten per VM)
  • und ein Quickstart-Tutorial, dass erklärt, wie Lerninhalte für den Schulstick erzeugt werden können.

Über diese Dokumentation

In diesem Repo entsteht die Dokumentation für das Schulstick Portal.

Die Dokumention wird automatisch von einer CI/CD-Pipeline gebaut und ist hier verfügbar.

Inhalte (in Arbeit)

  • Zunächst wird ein Quickstart-Tutorial erstellt
    • Wir wollen den Quickstart so kurz wie möglich halten, aber so hilfreich wie möglich gestalten. Um das ermöglichen zu können, haben wir folgende Überlegungen:
      • Das Portal soll Convention over configuration umsetzen. Wir wollen minimalen Aufwand von den Tutorialserstellern (nur eine Markdown-Datei) und haben selber die geeigneten Defaults statt der Notwendigkeit zu zusätzlichen Konfigurationen.
      • Der Quickstart bewirbt und Dokumentiert endnutzerfreundlich einen Bestcase der Einfachheit. Er bindet uns gleichzeitig daran, genau nach diesem Anspruch zu Entwickeln.
      • Um den Quickstart so kurz wie möglich halten zu können und gleichzeitig alle Notwendigen Hinweise/Erklärungen/Problemlösungen bereitzustellen, arbeiten wir mit Links zu eigenen Ergänzungen. Wir liefen viele Referenzen auf ausführlichere eigene Dokumentation.
flowchart TD
  subgraph doc[Dokumentation in diesem Repo]
    Quickstart([Quickstart]) --> Nutzerdoku([ausführlichere Nutzerdokumentation])
    Nutzerdoku --> Techdoku{{technische Dokumentation}}
    Techdoku --> Spezifikation>Spezifikation]
  end
  Quickstart --> www[(vorhandene externe Quellen)]
  Nutzerdoku --> www
  Techdoku --> www
  Spezifikation --> www
Loading
  • Die zusätzlich notwendigen ausführlicheren Dokumentationen / Spezifikationen werden ebenfalls in diesem Verzeichnis erarbeitet.

Der Quickstart stellt einerseits Anforderungen an die technische Umsetzung. Wir sind überzeugt, dass es sicht lohnt die Spezifikation an möglichst simple Minimalbeispiele anzupassen, weil sich genau das aus unseren Zielen ergibt. Dise bewusste Design-Entscheidung könnte als eine Art Versprechen / Claim / Anspruch an uns selbst verstanden und auch als Berbebotschaft verwendet werden.

flowchart TD
  Ziele((eigene Ziele)) --> Claim([Claim])
  Claim --> Quickstart([Quickstart])
Loading
  • Um den Quickstart als Grundlage für die Umsetzung entsprechend umsetzen zu können, Enthällt dieses Repo auch eine Formulierung unserer Ziele und Versprechen

  • Um einheitliche Begriffe (und vielleicht einprägsamme „Markennamen“) zu haben, wird ein Glossar erstellt.

About

Dokumentation for Schulstick-Tutorial erstellung

Resources

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages