diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32b6a948efa9e83d352c98d6285d269755775d7f..4259720b8abc2ee901a799f5783a5a5447cec3e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,17 @@ -// added Contributing file +# Contributing + +Wenn Sie zu diesem Repository beitragen wollen, besprechen Sie bitte zuerst die Änderung per Issue, +E-Mail oder eine andere Methode mit den Besitzern dieses Projekts ab. + +Bitte beachten Sie, dass wir einen Verhaltenskodex haben, den Sie bitte bei all Ihren Interaktionen mit dem Projekt befolgen. + +## Pull Request Process + +1. Bitte nur Inhalte ändern, wenn bereits über eine Änderung in einem Issue diskutiert wurde. + +2. Genau beschreiben, was und welche Änderungen vorgenommen wurden. Unbeschriebene Pull Request werden nicht bearbeitet. + +3. Änderungen werden getestet und auf korrekte Schreibweise geprüft. + +## Fehlermeldungen +Ein Fehler ist ein Problem, welches man reproduzieren kann, das heißt, dass das Problem durch den Code von der Dokumentationswebsite verursacht wird und Anderen dieses unter ähnlichen Umständen ebenfalls widerfährt. Gute Fehlermeldungen sind sehr hilfreich, also vielen Dank an dieser Stelle! diff --git a/README.md b/README.md index 6a803bb900f83755311990c6bcf424ece6b1cda4..4b286a6beb3c29f9842185c72732e12b09ee2bf9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ -# Design-System-Doku -Dokumentation der Design System Site https://www.design-system.sh/ + +# Design System Dokumentation + +## Digitale Produkte und Dienstleistungen entwerfen + +Innerhalb der Web- und Entwickler-Community gibt es keinen kohärenten Standard, der ein „Design-System“ allgemeingültig oder vollumfänglich beschreibt. Begriffe wie **„Style-Guide“, „Pattern Library“, „Design Manual“** oder gar **„Design Thinking“** werden wechselnd benutzt, um unterschiedlich umfängliche Gestaltungsvorlagen oder Prozesse zu beschreiben. + +Das hier vorgestellte Digital Design System ist aus der Erfahrung mit zahlreichen unterschiedlich komplexen und umfangreichen Projekten entstanden. Für den Erfolg eines Digital-Projekts hat sich dabei nicht nur die faktische Erfüllung von Anforderungen klassischer Lasten- und Pflichtenhefte erwiesen, sondern die **gemeinsame Identifikation, Entwicklung, Modifikation und Evaluation von Anforderungen und Bedürfnissen der Nutzer**, sowie die gemeinsame – Auftraggeber und Auftragnehmer – multiperspektivische Begleitung des gesamten Entwicklungsprozesses beginnend mit der Initiierung eines Projekts. + +Das Digital Design System Schleswig-Holstein ist daher ein **prozess- und nutzerzentriertes System**. Es bietet Anwendern ein Phasenmodell, Methoden und Handlungsmuster, mit denen sie User-Centered-Design in Ihrem Bereich für digitale Dienstleistungen, Produkte und Prozesse initiieren, mitentwickeln, begleiten und beurteilen können. + +Für die visuelle Designphase umfasst es darüberhinaus gestaltungsnahe, jedoch **allgemeingültige Hinweise zu Typografie, Farben, Abständen, Piktogramme** sowie zu konkreten Elementen von User-Interfaces wie Buttons, Navigation, Fortschrittsanzeigen, Benachrichtigungen u.s.f. + +## Contributing + +Contributions are always welcome! + +See `contributing.md` for ways to get started. + +Please adhere to this project's `code of conduct`. + + +## Support + +For support, contact info@itvsh.de or read more informations on the project page: https://www.design-system.sh. + + +## Tech Stack + +**Client:** VuePress, SCSS + +**Server:** Node, Gitlab Pages + + +## License + +[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/) + + \ No newline at end of file