diff --git a/de/CHANGELOG.md b/de/CHANGELOG.md index e69de29..f5b6cb7 100644 --- a/de/CHANGELOG.md +++ b/de/CHANGELOG.md @@ -0,0 +1,53 @@ +# Changelog +Alle bemerkenswerten Änderungen an diesem Projekt werden in dieser Datei +dokumentiert. + +Das Format basiert auf [Führe ein Changelog](https://keepachangelog.com/de/) +und dieses Projekt folgt [Semantic Versioning](https://semver.org/lang/de/). + +## [Releasenummer] - jjjj-mm-tt + +Hier wird die Zusammenfassung der Version festgehalten. Das Team ist angehalten, +die Beschreibung so kompakt wie möglich zu machen. + +### Hinzugefügt +- [PROJEKTNAME-XXXX](http://tickets.projectname.com/browse/PROJEKTNAME-XXXX) + MINOR Hier wird die Überschrift des ARBEITSPAKETS festgehalten. +- [PROJEKTNAME-YYYY](http://tickets.projectname.com/browse/PROJEKTNAME-YYYY) + PATCH Hier wird die Überschrift des ARBEITSPAKETS festgehalten. + +### Geändert + +### Korrigiert + +## [1.2.4] - 2017-03-15 + +Hier werden die Veränderungen für 1.2.4 festgehaltenen, die für die Benutzer +relevant sind. + +### Added + +### Changed + +- [PROJEKTNAME-ZZZZ](http://tickets.projectname.com/browse/PROJEKTNAME-ZZZZ) + PATCH Drupal.org wird jetzt als Composer verwendet. + +### Fixed + +- [PROJEKTNAME-TTTT](http://tickets.projectname.com/browse/PROJEKTNAME-TTTT) + PATCH Logik zu "Runsheet Teaser Delete" hinzugefügt um die verbundenen + Terminkarten ebenfalls zu löschen. + +## [1.2.3] - 2017-03-14 + +### Added + +### Changed + +### Fixed + +- [PROJEKTNAME-UUUU](http://tickets.projectname.com/browse/PROJEKTNAME-UUUU) + MINOR Korrekturen aus den Tests von Modul Foo +- [PROJEKTNAME-RRRR](http://tickets.projectname.com/browse/PROJEKTNAME-RRRR) + MAJOR Die Timeline aus Modul Foo verwendete die Zeitzone des Browsers für + die Ermittlung des Datums diff --git a/de/CODEBASE_STRUCTURE.md b/de/CODEBASE_STRUCTURE.md index e69de29..5d5b3a8 100644 --- a/de/CODEBASE_STRUCTURE.md +++ b/de/CODEBASE_STRUCTURE.md @@ -0,0 +1,58 @@ +Dies sind die Verzeichnisse, die wir aktiv in der Entwicklung einsetzen: + ++ [frontend/server/controllers](https://github.com/kylelobo/The-Documentation-Compendium/tree/master/frontend/server/controllers): +Die Controller führen die Businesslogik aus und machen die Server-API verfügbar. ++ [frontend/server/libs](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs): Bibliotheken und Dienstprogramme. ++ [frontend/server/libs/dao](https://github.com/The-Documentation-Compendium/tree/master/frontend/server/libs/dao): Data +Access Objects [DAO] und Value Objects [VO]. Klassen, die zur Darstellung von +Datenbankschemata und zur erleichterten Verwendung durch die Controller +verwendet werden. ++ [frontend/templates](https://github.com/The-Documentation-Compendium/tree/master/frontend/templates): Smarty-Vorlagen zum Generieren des HTML-Codes, der den Benutzern angezeigt +wird. ++ [frontend/www](https://github.com/The-Documentation-Compendium/tree/master/frontend/www): +Der vollständige Inhalt der Internetseite. + +### frontend / www +Inhalt: + ++ js / ++ css / + +#### js +Wie der Name schon sagt, befinden sich hier alle Javascript-Schriftarten und +Javascript-Frameworks. Codeänderungen, die hier vorgenommen werden, müssen vor +dem Upload mittels Minify komprimiert werden. + +#### css +Ähnlich wie bei js sind hier die durch Minify verkleinerten CSS-Dateien. + +### frontend / server +Inhalt: + +* dao / +* controllers / + +Keines dieser Module sollte für die Außenwelt zugänglich sein. Sie können +lediglich durch die Benutzeroberfläche aufgerufen werden. Aus diesem Grund +befinden sie sich im Ordner www. + +#### DAO / VO + +Der Ordner *dao* enthält die Klassen für die Datenzugriffsschicht. Hier gibt es +zwei relevante Dinge: *data access objects* und *value objects*. +*Value objects* (VO) sind nichts anderes als Klassen, die direkt jeder der +Tabellen in der Datenbank zugeordnet sind. Daher gibt es dort beispielse eine +Klasse namens Users, da es eine Tabelle mit dem selben Namen gibt. Diese Klasse +hat ihre Setter und Getter für jedes der Felder in der Datenbank. Die +*data access objects* (dao) sind statische Klassen für jede der Tabellen und +dienen dazu, die Objekte zu erhalten und zu dauerhaften *VO*'s zu machen. + +[Hier finden Sie weitere Informationen zu diesem Modell](http://www.ibm.com/developerworks/java/library/j-dao/) + +#### Controller + +In den Controllern werden die Entscheidungen getroffen. Der Controller verwendet +die DAOs und VOs, um Entscheidungen zu treffen, und ruft die Datenbank niemals +direkt auf. Auf diese Weise vermeiden wir separate Controller für jedes Modul +des Projekts. + diff --git a/de/CODE_OF_CONDUCT.md b/de/CODE_OF_CONDUCT.md index e69de29..66171a2 100644 --- a/de/CODE_OF_CONDUCT.md +++ b/de/CODE_OF_CONDUCT.md @@ -0,0 +1,85 @@ +# Verhaltenskodex für Mitwirkende + +## Unser Versprechen + +Im Interesse einer offenen und einladenden Umgebung versprechen wir als +Betreuer und Mitwirkende, die Mitwirkung in unserem Projekt und unserer +Community zu einer gemeinschaftlichen und gewaltlosen Erfahrung für Jederman, +unabhängig von Alter, Körpergröße, Behinderung, ethnischer Zugehörigkeit, +Geschlechtsmerkmalen und Geschlechtsidentität und Ausdruck, Erfahrungsniveau, +Bildung, sozioökonomischer Status, Nationalität, persönliches Aussehen, +Rasse, Religion oder sexuelle Identität und Orientierung zu machen. + +## Unsere Standards + +Beispiele für Verhaltensweisen, die zur Schaffung eines positiven Umfelds +beitragen, sind: + +* Eine einladende und integrative Sprache benutzen +* Respekt gegenüber unterschiedlichen Standpunkten und Erfahrungen haben +* Konstruktive Kritik würdevoll annehmen +* Konzentration auf das, was das Beste für die Community ist +* Empathie gegenüber anderen Community-Mitgliedern zeigen + +Beispiele für inakzeptables Verhalten der Teilnehmer sind: + +* Die Verwendung von sexualisierter Sprache oder Bildsprache und +unerwünschte sexuelle Aufmerksamkeit oder Aufwartungen +* Trolling, beleidigende/abfällige Kommentare und persönliche oder +politische Angriffe +* Öffentliche oder private Belästigung +* Veröffentlichung der privaten Informationen anderer, wie z. B. einer +physischen oder elektronischen Adresse, ohne ausdrückliche Genehmigung +* Jedes Verhalten, das in einem professionellen Umfeld vernünftigerweise +als unangemessen angesehen werden könnte + +## Unsere Verantwortung + +Die Projektbetreuer sind dafür verantwortlich, die Standards für akzeptables +Verhalten zu klären, und es wird erwartet, dass sie angemessene und faire +Korrekturmaßnahmen ergreifen, um auf Fälle von inakzeptablem Verhalten zu +reagieren. + +Projektbetreuer haben das Recht und die Verantwortung, Kommentare, Commits, +Code, Wiki-Änderungen, Probleme und andere Beiträge, die nicht mit diesem +Verhaltenskodex in Einklang stehen, zu entfernen, zu bearbeiten oder +abzulehnen oder Mitwirkende für Verhaltensweisen vorübergehend oder +dauerhaft zu sperren, die sie für unangemessen, bedrohlich, beleidigend +oder schädlich halten. + +## Umfang + +Dieser Verhaltenskodex gilt sowohl innerhalb von Projekträumen als auch im +öffentlichen Raum, wenn eine Person das Projekt oder seine Gemeinschaft +vertritt. Beispiele für die Vertretung eines Projekts oder einer Community sind +die Verwendung einer offiziellen Projekt-E-Mail-Adresse, die Veröffentlichung +über ein offizielles Social-Media-Konto oder die Vertretung bei einer Online- +oder Offline-Veranstaltung. Die Darstellung eines Projekts kann von den +Projektbetreuern weiter definiert und erklärt werden. + +## Durchführung + +Fälle von missbräuchlichem, belästigendem oder anderweitig inakzeptablem +Verhalten können gemeldet werden, indem Sie sich an das Projektteam unter +kylelobo20@gmail.com wenden. Alle Beschwerden werden geprüft und untersucht und +führen zu einer Antwort, die als notwendig und den Umständen entsprechend +erachtet wird. Das Projektteam ist verpflichtet, die Vertraulichkeit gegenüber +dem Berichterstatter eines Vorfalls zu wahren. Weitere Einzelheiten zu +bestimmten Durchsetzungsrichtlinien können separat veröffentlicht werden. + +Projektbetreuer, die den Verhaltenskodex nicht nach bestem Wissen und Gewissen +befolgen oder durchsetzen, können mit vorübergehenden oder dauerhafte +Konsequenzen konfrontiert werden, die von anderen Mitgliedern der Projektleitung +festgelegt werden. + +## Quellverweis + +Dieser Verhaltenskodex wurde aus dem [Contributor Covenant][Homepage], +Version 1.4, verfügbar unter +https://www.contributor-covenant.org/version/1/4/code-of-conduct.html, +übernommen. + +[Homepage]: https://www.contributor-covenant.org + +Antworten auf häufig gestellte Fragen zu diesem Verhaltenskodex finden Sie unter +https://www.contributor-covenant.org/faq diff --git a/de/CODING_GUIDELINES.md b/de/CODING_GUIDELINES.md index e69de29..aab0f52 100644 --- a/de/CODING_GUIDELINES.md +++ b/de/CODING_GUIDELINES.md @@ -0,0 +1,30 @@ +# Sourcecoderichtlinien + +- Sie können überprüfen, ob Ihr Code diesen Richtlinien entspricht, indem Sie +`stuff/php-format.py validate` ausführen +- Tabulatoren, keine Leerzeichen +- Das Zeilenende sollte im Unix-Stil (`\n`) und nicht im Windows-Stil (`\r\n`) +sein. +- Das Öffnen von Klammern erfolgt in derselben Zeile wie die letzte Anweisung +``` + if (condition) { + stuff; + } +``` +- Ein Leerzeichen zwischen Schlüsselwörtern und Klammern für: `if`, `else`, +`while`, `switch`, `catch`, `function` +- Funktionsaufrufe haben vor den Klammern kein Leerzeichen +- In den Klammern bleiben keine Leerzeichen +- Ein Leerzeichen nach jedem Komma, jedoch ohne Leerzeichen davor +- Alle binären Operatoren müssen ein Leerzeichen davor und danach haben +- Es sollte nicht mehr als eine aneinanderfolgende Leerzeile geben +- Es sollten keine leeren Kommentare vorhanden sein +- Sie sollten keine Blockkommentare `/* ... */` verwenden, sondern nur +Zeilenkommentare `// ...` +- Änderungen der Funktionalität müssen gemeinsam mit ihren jeweiligen neuen / +geänderten Tests hochgeladen werden +- Exceptions müssen verwendet werden, um fehlerhafte Zustände zu melden. Die +Verwendung von Funktionen, die true / false zurückgeben, ist zulässig, wenn es +sich um erwartete Werte handelt +- Verwenden Sie gegebenenfalls [RAII](http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization), insbesondere bei der Verwaltung von +Ressourcen (Dateien usw.) \ No newline at end of file diff --git a/de/CONTRIBUTING.md b/de/CONTRIBUTING.md index e69de29..3886758 100644 --- a/de/CONTRIBUTING.md +++ b/de/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Richtlinien für Beiträge + +- An "The Documentation Compendium" mit zu wirken ist ziemlich einfach. Dieses +Dokument zeigt die ersten Schritte + +## Allgemeines +- Die [Codebase Structure](./CODEBASE_STRUCTURE.md) enthält detaillierte +Informationen zur Struktur der verschiedenen Dateien in diesem Projekt +- Es muss sicher gestellt sein, dass alle vorgenommenen Änderungen den +[Coding Guidelines](./CODING_GUIDELINES.md) dieses Repos entsprechen + +## Änderungen einreichen + +- Einen Fork des Repos erzeugen + - +- Einen neuen Branch auschecken und einen Namen vergeben, der beschreibt, was +geändert wird (z.B. fooBar): + - Beispiel: + ```` + $ git checkout -b fooBar + ```` + Falls ein Fehler ausgegeben wird, muss möglicherweise der aktuelle Stand + durch folgende Befehle geholt werden: + ```` + $ git remote update && git fetch + ```` + - Immer nur einen Branch pro Fix / Feature verwenden +- Änderungen übernehmen + - Bitte eine Git-Nachricht verfassen, die beschreibt, was geändert wurde + - Bitte sicherstellen, dass die Commits den [Konventionen](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md) + entsprechen + - Immer in das geforkte Repository commiten + - Beispiel: + ```` + $ git commit -am 'Add some fooBar' + ```` +- In den Branch pushen + - Example: + ```` + $ git push origin BRANCH_NAME + ```` +- Einen Pull-Request eröffnen + - Sicherstellen, dass der PR an den Zweig fooBar gesendet wird + - Travis CI is watching you! + +Wenn diese Anweisungen befolgt werden, landet der PR ziemlich sicher im +Haupt-Repo! \ No newline at end of file diff --git a/de/ISSUE_TEMPLATES/bug_report.md b/de/ISSUE_TEMPLATES/bug_report.md index e69de29..43377e1 100644 --- a/de/ISSUE_TEMPLATES/bug_report.md +++ b/de/ISSUE_TEMPLATES/bug_report.md @@ -0,0 +1,39 @@ +--- +name: Fehlerbericht +about: Einen Bericht erstellen um uns die Möglichkeit zur Verbesesrung zu geben +title: '' +labels: '' +assignees: '' +--- + +**Fehlerbeschreibung:** + +Eine klare und präzise Beschreibung des Fehlers. + +**Reproduktion:** + +Schritte zum Reproduzieren des Verhaltens: +1. Gehe nach '...' +2. Clicke auf '....' +3. Scrolle bis '....' +4. Erhalte den Fehler + +**Erwartetes Verhalten:** +Eine klare und präzise Beschreibung dessen, was erwartet wird. + +**Screenshots:** +Gegebenenfalls Schreenshots hinzufügen um das Problem zu erklären. + +**Desktop (bitte die folgenden Informationen bekanntgeben):** + - OS: [z.B. iOS] + - Browser [z.B. chrome, safari] + - Version [z.B. 22] + +**Smartphone (bitte die folgenden Informationen bekanntgeben):** + - Device: [z.B. iPhone6] + - OS: [z.B. iOS8.1] + - Browser [z.B. stock browser, safari] + - Version [z.B. 22] + +**Zusätzlicher Kontext:** +Alle weitere Angaben in Verbindung mit dem Problem. diff --git a/de/ISSUE_TEMPLATES/custom.md b/de/ISSUE_TEMPLATES/custom.md index e69de29..081b13a 100644 --- a/de/ISSUE_TEMPLATES/custom.md +++ b/de/ISSUE_TEMPLATES/custom.md @@ -0,0 +1,10 @@ +--- +name: Benutzerdefinierte Vorlage +about: Den Zweck der Vorlage hier beschreiben. +title: '' +labels: '' +assignees: '' + +--- + + diff --git a/de/ISSUE_TEMPLATES/feature_request.md b/de/ISSUE_TEMPLATES/feature_request.md index e69de29..cfe9909 100644 --- a/de/ISSUE_TEMPLATES/feature_request.md +++ b/de/ISSUE_TEMPLATES/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Funktionsanfrage +about: Vorschlag einer Idee für dieses Projekt +title: '' +labels: '' +assignees: '' + +--- + +**Bezieht sich Ihre Funktionsanfrage auf ein Problem? Bitte beschreiben.** +Eine klare und präzise Beschreibung des Problems. Z.B.: Ich bin immer +frustriert, wenn [...] + +**Beschreibung der gewünschten Lösung** +Eine klare und präzise Beschreibung dessen, was passieren soll. + +**Beschreibung der Alternativen, die Sie in Betracht gezogen wurden** +Eine klare und präzise Beschreibung aller alternativen Lösungen oder Funktionen, +die in Betracht gezogen wurden. + +**Zusätzlicher Kontext** +Weiterer Kontexte oder Screenshots zur Funktionsanforderung. diff --git a/de/PULL_REQUEST_TEMPLATE.md b/de/PULL_REQUEST_TEMPLATE.md index e69de29..773c0c6 100644 --- a/de/PULL_REQUEST_TEMPLATE.md +++ b/de/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +### Checkliste für Pull-Requests +🚨 Bitte lesen Sie die [Richtlinien für Beiträge](./CONTRIBUTING.md) zu diesem Repository. + +- [ ] Sicherstellen, dass ein **Themen-/Feature-/Bugfix-Zweig** requestet wird +(rechte Seite). Nicht den master Branch requesten! +- [ ] Sicherstellen, dass eine Pull-Anfragen für den **fooBar-Zweig** (linke +Seite) gestellt wird. +- [ ] Überprüfen, ob die Commits Struktur der vorgegebenen Struktur entspricht. +- [ ] Sicherstellen, dass die Codeerweiterungen sowohl Code Linting- als auch +Unit-Tests erfolgreich bestehen. + +### Beschreibung +Bitte den Pull-Request beschreiben. + +❤️ Vielen Dank! diff --git a/de/README_TEMPLATES/Bot.md b/de/README_TEMPLATES/Bot.md index e69de29..f353966 100644 --- a/de/README_TEMPLATES/Bot.md +++ b/de/README_TEMPLATES/Bot.md @@ -0,0 +1,145 @@ +

+ + Bot logo +

+ +

Name des Bots

+ +
+ + [![Status](https://img.shields.io/badge/status-active-success.svg)]() + [![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot) + [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) + [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) + [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE) + +
+ +--- + +

+ 🤖 Ein paar Zeilen, die beschreiben, was der Bot macht. +
+

+ +## 📝 Inhaltsverzeichnis ++ [Über](#ueber) ++ [Demo / Arbeitsweise](#demo) ++ [Funktionsbeschreibung](#funktionsbeschreibung) ++ [Verwendung](#verwendung) ++ [Einstieg](#einstieg) ++ [Bereitstellen eines eigenen Bots](#bereitstellung) ++ [Erstellt mit](#erstellt_mit) ++ [TODO](../TODO.md) ++ [Mitwirkung](../CONTRIBUTING.md) ++ [Autoren](#autoren) ++ [Danksagung](#danksagung) + +## 🧐 Über +Ungefähr 1-2 Absätze, die den Zweck des Bots beschreiben. + +## 🎥 Demo / Arbeitsweise +![Arbeitsweise](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif) + +## 💭 Funktionsbeschreibung +Der Bot extrahiert zuerst das Wort aus dem Kommentar und ruft dann +Wortdefinitionen, ein Beispiel und Abstammung aus der Oxford Dictionary-API ab. + +Wenn das Wort im Oxford Dictionary nicht vorhanden ist, gibt die Oxford API eine +404-Antwort zurück, worauf der Bot dann versucht, Ergebnisse aus der Urban +Dictionary API abzurufen. + +Der Bot verwendet die Pushshift-API zum Abrufen von Kommentaren, das PRAW-Modul +zum Antworten auf Kommentare und Heroku als Server. + +Der gesamte Bot ist in Python 3.6 geschrieben. + +## 🎈 Verwendung + +Um den Bot zu verwenden folgenden Befehl tippen: +``` +!dict word +``` +Der erste Teil, als "!dict" **ist nicht** Case sensitiv. + +Der Bot gibt Ihnen dann die Definition des Wortes im Oxford Dictionary (oder +Urban Dictionary; falls das Wort im Oxford Dictionary nicht vorhanden ist) +als Kommentarantwort. + +### Beispiel: + +> !dict what is love + +**Definition:** + +Baby, dont hurt me~ +Dont hurt me~ no more. + +**Beispiel:** + +Dude1: Bruh, what is love?
+Dude2: Baby, dont hurt me, dont hurt me- no more!
+Dude1: dafuq? + +**Quelle:** https://www.urbandictionary.com/define.php?term=what%20is%20love + +--- + +Beep boop. Ich bin ein Bot. Wenn es Probleme gibt, kontaktiere meinen [Meister](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot) + +Willst du einen ähnlichen reddit Bot machen? Probiere: [GitHub](https://github.com/kylelobo/Reddit-Bot) + +## 🏁 Einstieg +Mit diesen Anweisungen erhalten Sie eine Kopie des Projekts, das zu +Entwicklungs- und Testzwecken auf Ihrem lokalen Computer ausgeführt werden kann. +Hinweise zum Bereitstellen des Projekts auf einem Live-System finden Sie unter +[Bereitstellen eines eigenen Bots](#bereitstellung). + +### Voraussetzungen + +Welche Dinge werden benötigt um die Software zu installieren und wie wird sie +installiert? + +``` +Hier Beispiele geben +``` + +### Installation + +Eine Schritt für Schritt Anleitung die zeigt, wie die Entwicklungsumgebung zum +Laufen gebracht wird. + +Beschreibe den Schritt + +``` +Gib ein Beispiel +``` + +Und wiederhole + +``` +bis zur Fertigstellung. +``` + +Zum Schluss noch ein Beispiel, wie einige Daten aus dem System geholt werden +oder für eine kleine Demo verwendet werden. + +## 🚀 Bereitstellen eines eigenen Bots +Ein Beispielprojekt zur Bereitstellung Ihres Bots finden Sie in meiner eigenen +Konfiguration: + ++ **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot + +## ⛏️ Erstellt mit ++ [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper ++ [Heroku](https://www.heroku.com/) - SaaS hosting platform + +## ✍️ Autoren ++ [@kylelobo](https://github.com/kylelobo) - Idee & Erste Version + +Siehe auch die Liste der [Mitwirkenden](https://github.com/kylelobo/The-Documentation-Compendium/contributors), die an diesem Projekt teilgenommen haben. + +## 🎉 Danksagung ++ Hut ab vor Jedem, dessen Code verwendet wurde ++ Inspiration ++ Verweise diff --git a/de/README_TEMPLATES/Hackathon.md b/de/README_TEMPLATES/Hackathon.md index e69de29..fec314f 100644 --- a/de/README_TEMPLATES/Hackathon.md +++ b/de/README_TEMPLATES/Hackathon.md @@ -0,0 +1,127 @@ +

+ + Project logo +

+

Projekttitel

+ +
+ + [![Hackathon](https://img.shields.io/badge/hackathon-projekttitel-orange.svg)](http://hackathon.url.com) + [![Status](https://img.shields.io/badge/status-active-success.svg)]() + [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) + [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) + [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md) + +
+ +--- + +

+ Ein paar Zeilen, die das Projekt beschreiben. +
+

+ +## 📝 Inhaltsverzeichnis +- [Problemstellung](#problemstellung) +- [Idee / Lösung](#idee) +- [Abhängigkeiten / Einschränkungen](#einschraenkungen) +- [Zukünftiger Geltungsbereich](#geltungsbereich) +- [Einstieg](#einstieg) +- [Verwendung](#verwendung) +- [Technologie-Stack](#tech_stack) +- [Mitwirkung](../CONTRIBUTING.md) +- [Autoren](#autoren) +- [Danksagung](#danksagung) + +## 🧐 Problemstellung + +Es ist nützlich, beim Schreiben einer Problemstellung ein bestimmtes Format zu +entwerfen und diesem zu folgen. Es gibt verschiedene Möglichkeiten, dies zu tun. +Das Folgende ist eine einfache und unkomplizierte Vorlage, die häufig in der +Geschäftsanalyse eingesetzt wird, um den Fokus auf der Definition des Problems +zu halten. + +- IDEAL: In diesem Abschnitt wird der gewünschte oder Soll-Zustand des Prozesses +oder Produkts beschrieben. Im Großen und Ganzen sollte dieser Abschnitt +veranschaulichen, wie die erwartete Umgebung nach der Implementierung der Lösung +aussehen würde. +- REALITÄT: In diesem Abschnitt wird der aktuelle oder Ist-Zustand des Prozesses +oder Produkts beschrieben. +- FOLGEN: In diesem Abschnitt werden die Auswirkungen auf das Unternehmen +beschrieben, wenn das Problem nicht behoben oder verbessert wird. Dies schließt +Kosten ein, die mit Kapitalverlust, Zeit, Produktivität, Wettbewerbsvorteil usw. +verbunden sind. + +Mit Hilfe dieses Formats wird ein Dokument erstellt, das genutzt werden kann um +das Problem zu vermitteln und Anforderungen zu definieren, die zu einer +erfolgreichen Lösung führen. +## 💡 Idee / Lösung + +In diesem Abschnitt werden mögliche Lösungen beschrieben. + +Sobald die Abschnitte Ideal, Realität und Konsequenzen abgeschlossen und +verinnerlicht wurden wird es einfacher, eine Lösung zur Klärung des Problems +zu definieren. + +## ⛓️ Abhängigkeiten / Einschränkungen +- Was sind die Abhängigkeiten des Projekts? +- Beschreibe jede Einschränkung kurz und bündig +- Erkläre warum die Einschränkung besteht +- Begründe, warum die Einschränkung mit den ausgewählten Methoden nicht +beseitigt werden konnte. +- Bewerte die Auswirkungen jeder Einschränkung in Bezug auf das Gesamtergebnis +des Projekts und beschreibe gegebenenfalls, wieso diese Einschränkungen auf die +Notwendigkeit weiterer Nachforschungen hinweisen. + +## 🚀 Zukünftiger Geltungsbereich +Schreiben darüber, was im Verlauf des Hackathons nicht entwickelt werden konnte +und darüber, was Ihr Projekt in Zukunft erreichen kann. + +## 🏁 Einstieg +Mit diesen Anweisungen erhalten Sie eine Kopie des Projekts, das zu +Entwicklungs- und Testzwecken auf Ihrem lokalen Computer ausgeführt werden kann. + +### Voraussetzungen + +Welche Dinge werden benötigt um die Software zu installieren und wie wird sie +installiert? + +``` +Hier Beispiele geben +``` + +### Installation + +Eine Schritt für Schritt Anleitung die zeigt, wie die Entwicklungsumgebung zum +Laufen gebracht wird. + +Beschreibe den Schritt + +``` +Gib ein Beispiel +``` + +Und wiederhole + +``` +bis zur Fertigstellung. +``` + +## 🎈 Verwendung +Füge Hinweise zur Verwendung des Systems hinzu. + +## ⛏️ Technologie-Stack +- [MongoDB](https://www.mongodb.com/) - Database +- [Express](https://expressjs.com/) - Server Framework +- [VueJs](https://vuejs.org/) - Web Framework +- [NodeJs](https://nodejs.org/en/) - Server Environment + +## ✍️ Autoren ++ [@kylelobo](https://github.com/kylelobo) - Idee & Erste Version + +Siehe auch die Liste der [Mitwirkenden](https://github.com/kylelobo/The-Documentation-Compendium/contributors), die an diesem Projekt teilgenommen haben. + +## 🎉 Danksagung ++ Hut ab vor Jedem, dessen Code verwendet wurde ++ Inspiration ++ Verweise diff --git a/de/README_TEMPLATES/Minimal.md b/de/README_TEMPLATES/Minimal.md index e69de29..f4d7817 100644 --- a/de/README_TEMPLATES/Minimal.md +++ b/de/README_TEMPLATES/Minimal.md @@ -0,0 +1,47 @@ +# Projekttitel + +## Inhaltsverzeichnis ++ [Über](#ueber) ++ [Einstieg](#einstieg) ++ [Verwendung](#verwendung) ++ [Mitwirkung](../CONTRIBUTING.md) + +## Über +Ungefähr 1-2 Absätze, die den Zweck des Projekts beschreiben. + +## Einstieg +Mit diesen Anweisungen erhalten Sie eine Kopie des Projekts, das zu +Entwicklungs- und Testzwecken auf Ihrem lokalen Computer ausgeführt werden kann. + +### Voraussetzungen + +Welche Dinge werden benötigt um die Software zu installieren und wie wird sie +installiert? + +``` +Hier Beispiele geben +``` + +### Installation + +Eine Schritt für Schritt Anleitung die zeigt, wie die Entwicklungsumgebung zum +Laufen gebracht wird. + +Beschreibe den Schritt + +``` +Gib ein Beispiel +``` + +Und wiederhole + +``` +bis zur Fertigstellung. +``` + +Zum Schluss noch ein Beispiel, wie einige Daten aus dem System geholt werden +oder für eine kleine Demo verwendet werden. + +## Verwendung + +Füge Hinweise zur Verwendung des Systems hinzu. diff --git a/de/README_TEMPLATES/README.md b/de/README_TEMPLATES/README.md index 414d525..9f2e94c 100644 --- a/de/README_TEMPLATES/README.md +++ b/de/README_TEMPLATES/README.md @@ -1,4 +1,4 @@ -### This folder contains various README Templates that one can use based on the type of project. +### Dieser Ordner enthält verschiedene README-Vorlagen, die je nach Projekttyp verwendet werden können. 1. [Bot.md](/README%20Templates/Bot.md) - 2. [Hackathon.md](/README%20Templates/Hackathon.md) - diff --git a/de/README_TEMPLATES/Standard.md b/de/README_TEMPLATES/Standard.md index e69de29..e4ffd28 100644 --- a/de/README_TEMPLATES/Standard.md +++ b/de/README_TEMPLATES/Standard.md @@ -0,0 +1,111 @@ +

+ + Project logo +

+ +

Projekttitel

+ +
+ + [![Status](https://img.shields.io/badge/status-active-success.svg)]() + [![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) + [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) + [![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE) + +
+ +--- + +

Ein paar Zeilen, die das Projekt beschreiben. +
+

+ +## 📝 Table of Contents +- [Über](#ueber) +- [Einstieg](#einstieg) +- [Durchführung von Tests](#tests) +- [Bereitstellung](#bereitstellung) +- [Verwendung](#verwendung) +- [Erstellt mit](#erstellt_mit) +- [TODO](../TODO.md) +- [Mitwirkung](../CONTRIBUTING.md) +- [Autoren](#autoren) +- [Danksagung](#danksagung) + +## 🧐 Über +Ungefähr 1-2 Absätze, die den Zweck des Bots beschreiben. + +## 🏁 Einstieg +Mit diesen Anweisungen erhalten Sie eine Kopie des Projekts, das zu +Entwicklungs- und Testzwecken auf Ihrem lokalen Computer ausgeführt werden kann. +Hinweise zum Bereitstellen des Projekts auf einem Live-System finden Sie unter +[Bereitstellung](#bereitstellung). + +### Voraussetzungen + +Welche Dinge werden benötigt um die Software zu installieren und wie wird sie +installiert? + +``` +Hier Beispiele geben +``` + +### Installation + +Eine Schritt für Schritt Anleitung die zeigt, wie die Entwicklungsumgebung zum +Laufen gebracht wird. + +Beschreibe den Schritt + +``` +Gib ein Beispiel +``` + +Und wiederhole + +``` +bis zur Fertigstellung. +``` + +Zum Schluss noch ein Beispiel, wie einige Daten aus dem System geholt werden +oder für eine kleine Demo verwendet werden. + +## 🔧 Durchführung von Tests +Erkläre, wie automatische Tests für das System durchgeführt werden können. + +### In End-to-End Tests zerlegen +Erkläre was getestet wird und wieso. + +``` +Gib ein Bespiel +``` + +### Und coding style Tests +Erkläre was getestet wird und wieso. + +``` +Gib ein Bespiel +``` + +## 🚀 Bereitstellung +Zusätzliche Hinweise dazu, wie das Projekt auf einem Livesystem bereitgestellt +werden kann. + +## 🎈 Verwendung +Füge Hinweise zur Verwendung des Systems hinzu. + +## ⛏️ Erstellt mit +- [MongoDB](https://www.mongodb.com/) - Database +- [Express](https://expressjs.com/) - Server Framework +- [VueJs](https://vuejs.org/) - Web Framework +- [NodeJs](https://nodejs.org/en/) - Server Environment + +## ✍️ Autoren +- [@kylelobo](https://github.com/kylelobo) - Idee & Erste Version + +Siehe auch die Liste der [Mitwirkenden](https://github.com/kylelobo/The-Documentation-Compendium/contributors), die an diesem Projekt teilgenommen haben. + +## 🎉 Danksagung +- Hut ab vor Jedem, dessen Code verwendet wurde +- Inspiration +- Verweise diff --git a/de/TODO.md b/de/TODO.md index f484282..e8b3797 100644 --- a/de/TODO.md +++ b/de/TODO.md @@ -2,5 +2,7 @@ --- -- [ ] переводить шаблоны +- [x] Erledigte Anpassung +- [ ] Geplante Anpassungen ... +- [ ] Geplante Anpassungen ...