databinding.documentation.templates
8.2.240130.1
Prefix Reserved
dotnet new install databinding.documentation.templates::8.2.240130.1
databinding.documentation.templates
Unsere Vorlagen sollen uns dabei unterstützen Wissen für ein gemeinsames Verständnis festzuhalten.
In der aktuellen Version stehen diverse Vorlagen im Kontext der Softwareentwicklung zur Verfügung.
Überblick
Aktuell enthält das Paket folgende Vorlagen:
| Name | Template | Beschreibung | Format | Sprache |
|---|---|---|---|---|
| Architekturvorlage Arc42 | db-arc42doc | Die Arc42 Vorlage ist ein praktisches Werkzeug für die Softwarearchitektur-Dokumentation, das strukturierte Leitfäden und Abschnitte bietet, um alle Aspekte einer Softwarearchitektur effektiv zu beschreiben. Es umfasst Themen wie Systemkontext, Bausteine, Schnittstellen, Datenmodellierung und Infrastruktur, wodurch es ein umfassendes Framework für Architekten und Entwickler darstellt. | Markdown, AsciiDoc, Word | de/en |
| Vorlage Entwurfsentscheidung (ADR) | db-adr | Ein Architecture Decision Record (ADR) ist ein Dokument, das eine wichtige architektonische Entscheidung zusammen mit ihrem Kontext und ihren Konsequenzen festhält. Es dient als eine Art Tagebuch oder Chronik, die es Teams ermöglicht, die Gründe für spezifische Design- und Architekturentscheidungen im Laufe der Zeit nachzuvollziehen und zu verstehen. | Markdown, AsciiDoc | de/en |
| Cockburn Schablone | db-cockburn | Die Cockburn-Schablone, entwickelt von Alistair Cockburn, ist eine Methode zur Strukturierung von Use Cases in der Softwareentwicklung, um Benutzeranforderungen klar und effizient zu dokumentieren. Sie betont eine einfache und verständliche Sprache und gliedert Use Cases in Abschnitte wie Ziel, Haupterfolgsszenario und Erweiterungen, um ein klares Bild der Benutzerinteraktion mit dem System zu vermitteln. | Markdown, AsciiDoc | de/en |
| Konzept | db-concept | Leere Vorlage mit Titel als Einstiegspunkt zur Erstellung weitere Unterseiten für die Architekturvorlage. | Markdown, AsciiDoc | de, en |
Anfangen
Vorraussetzungen
Installierte .NET SDK.
Installieren
Installieren der Vorlagen:
dotnet new install databinding.documentation.templates
Verifikation:
dotnet new list
Bei erfolgreicher Installation sind die Templates gemäss der Übersicht ersichtlich.
Deinstallieren
Um das Template zu deinstallieren, folgenden Befehl ausführen:
dotnet new uninstall databinding.documentation.templates
Templates verwenden
Für die Ausführung der Templates stehen folgende Parameter bereit:
- Language (de/en) default: de
- Format (ascii, markdown, docx) default: markdown
- Name (Standard: template) Titel der Vorlage
Item erstellen
Um die arc42 Struktur zu erstellen, folgender Befehl eingeben:
dotnet new db-arc42doc --Format <Format> --Language <Sprache> -n <Name>
Für die Word Vorlage wird der Parameter Name nicht unterstützt.
Das Template wird Standardmässig im ./arc42 Verzeichnis, relativ zum Ausführort des Befehls, erstellt.
This package has no dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last updated |
|---|---|---|
| 8.2.240130.1 | 1,363 | 1/31/2024 |
| 8.2.231115.8 | 2,145 | 11/15/2023 |