Skip to content

Commit

Permalink
automatically create pdf releases from markdown notes (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve2955 authored Nov 10, 2020
1 parent 7118f54 commit 3373e5c
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 26 deletions.
68 changes: 68 additions & 0 deletions .github/workflows/pandoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: Create PDF release from markdown

on:
push:
branches:
- main

jobs:
convert_via_pandoc_and_release:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v2
- run: |
mkdir output
- uses: docker://pandoc/latex:2.9
with:
args: --output=output/DBS.pdf --pdf-engine=xelatex -V geometry:margin=3cm DBS/README.md
- uses: docker://pandoc/latex:2.9
with:
args: --output=output/SWE.pdf --pdf-engine=xelatex -V geometry:margin=3cm SWE/README.md
- uses: docker://pandoc/latex:2.9
with:
args: --output=output/PRO.pdf --pdf-engine=xelatex -V geometry:margin=3cm PRO/README.md
- uses: docker://pandoc/latex:2.9
with:
args: --output=output/RES.pdf --pdf-engine=xelatex -V geometry:margin=3cm RES/README.md
- uses: actions/upload-artifact@master
with:
name: output
path: output
- run: |
zip --junk-paths pdfs output/DBS.pdf output/SWE.pdf output/RES.pdf output/PRO.pdf
- uses: meeDamian/[email protected]
with:
token: ${{ secrets.ACCESS_TOKEN }}
tag: pdf-release
name: PDFs
body: Automated release
gzip: false
files: output/DBS.pdf
allow_override: true
- uses: meeDamian/[email protected]
with:
token: ${{ secrets.ACCESS_TOKEN }}
tag: pdf-release
name: PDFs
body: Automated release
gzip: false
files: output/PRO.pdf
allow_override: true
- uses: meeDamian/[email protected]
with:
token: ${{ secrets.ACCESS_TOKEN }}
tag: pdf-release
name: PDFs
body: Automated release
gzip: false
files: output/SWE.pdf
allow_override: true
- uses: meeDamian/[email protected]
with:
token: ${{ secrets.ACCESS_TOKEN }}
tag: pdf-release
name: PDFs
body: Automated release
gzip: false
files: output/RES.pdf
allow_override: true
File renamed without changes.
56 changes: 30 additions & 26 deletions SWE/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ Systemanalyse
## User Story Format

> Als ...
>
>
> möchte ich ...
>
>
> um ... zu
- selber so formulieren und einfordern
Expand Down Expand Up @@ -118,14 +118,14 @@ Zuletzt die Methode hinterfragen

> orientiert sich an der Auto-Produktion
- Autoproduktion:
- Autoproduktion:

- kalkulierbare Kosten + Risiken (Planung und Produktion sind getrennt)
- vorhersagbares Ergebnis (Industrialisierung)
- Qualität (ständiges Messen)

- Software Produktion

- Kosten sind **nicht** zuverlässig vorhersagbar
- viele Fehlschläge in der Branche
- schlecht quantifizierbar
Expand Down Expand Up @@ -153,11 +153,13 @@ Zuletzt die Methode hinterfragen

**5 Phasen** -> Stufenmodell

- Analyse
- Design
- Programmierung
- Integration / Test
- Einsatz / Wartung
```
Analyse
└─ Design
└─ Programmierung
└─ Integration / Test
└─ Einsatz / Wartung
```

**Analyse-Phase**

Expand Down Expand Up @@ -220,11 +222,13 @@ MVPs fehlen
### Iteriertes Phasenmodell

- Analyse
- Design
- Programmierung
- Integration / Tests
- Einsatz / Wartung
```
Analyse
└─ Design
└─ Programmierung
└─ Integration / Test
└─ Einsatz / Wartung
```

Hier wird immer wieder in eine Phase "zurück gesprungen", falls etwas nicht passt.

Expand All @@ -243,7 +247,7 @@ Hier wird immer wieder in eine Phase "zurück gesprungen", falls etwas nicht pas
- zeigt ausgewählte Eigenschaften
- darf bzw. **muss** quick & dirty sein

**Gefahr:**
**Gefahr:**
- wird nicht wieder weggeworfen
- wird als Doku-Ersatz missbraucht
- Aufwand ist relativ hoch
Expand All @@ -253,14 +257,14 @@ Hier wird immer wieder in eine Phase "zurück gesprungen", falls etwas nicht pas
### Evolutionäre SW-Entwicklung

**evolutionär:**
**evolutionär:**

- Bewährtes weiterentwickeln
- unnötige Features abschalten

-> Weiterentwicklung des Prototypen

-> Problem:
-> Problem:
- ständige Änderungen im Quellcode
- evolutionäre Dokumentation

Expand Down Expand Up @@ -316,7 +320,7 @@ Analyse -> High-Level-Design -> Low-Level-Design -> Implementierung -> Unit Test

### Eine Ausprägung des V-Modells: "V-Modell XT"

- Ursprung: militärscher Bereich
- Ursprung: militärscher Bereich
- **Ziele:**
- (1) Kosten transparent machen -> Kosten-Limitierung wird möglich
- (2) Mindeststandard an Qualitäts-Maßnahmen zu garantieren
Expand Down Expand Up @@ -450,10 +454,10 @@ Weitere Beispiele: Windows 2000, Crysler Payroll-System

**Vor-und Nachteile**

Allgemeine Kriterien:
Allgemeine Kriterien:
- Kosten / Kosten
- Qualität der Ergebnisse
- Flexibilität
- Qualität der Ergebnisse
- Flexibilität
- gegenseitiges Lernen
- Overhead (Betreuung, Komplexität)
- Tests
Expand All @@ -471,10 +475,10 @@ Allgemeine Kriterien:
## Empirische Prozess Kontrolle

**PDCA Prinzip:**
Plan -> Do -> Check -> Act -> (zurück zu Plan)
Plan -> Do -> Check -> Act -> (zurück zu Plan)

> - kurze Planungszeit, schnell in das Doing übergehen und nach kurzer Zeit prüfen
> - soll zu einer besseren Lösung führen
> - soll zu einer besseren Lösung führen
- transparenter Prozess
- Doing + Überprüfung + Anpassung
Expand All @@ -497,7 +501,7 @@ Plan -> Do -> Check -> Act -> (zurück zu Plan)
- Ziel
- Jeder User-Story werden eine Priorität und sog. Story-Points zugeordnet
> Story-Points sind eine Aufwandsschätzung, die jedoch **nicht** die geschätzen Arbeitsstunden darstellen
- desweiteren enthält die User-Story eine Risikoabschätzung
- desweiteren enthält die User-Story eine Risikoabschätzung
- hinterher wird an der User-Story der tatsächliche Aufwand dokumentiert

Tests auf der "Rückseite":
Expand Down Expand Up @@ -532,7 +536,7 @@ Angenommen ... <Vork.> wenn ... <Aktion> dann ... <Ergebnis>
- Prozessbeobachter
- dokumentiert u.A. den Fortschritt der Entwicklung
- hilft dem Team, Probleme zu lösen
- idealerweise ist der SCRUM-Master ein fachfremder Mitarbeiter
- idealerweise ist der SCRUM-Master ein fachfremder Mitarbeiter

### Vorgehen in SCRUM
1. Vision -> Produktbacklog
Expand Down

0 comments on commit 3373e5c

Please sign in to comment.