Merge pull request #4 from APIOpsCycles/text-improvements-030104

Improved exports in package and texts for canvases, stations and resources

Author: mniinio

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "apiops-cycles-method-data",
-  "version": "3.1.3",
+  "version": "3.2.0",
   "description": "APIOps Cycles Method data and canvases",
   "license": "Apache-2.0",
   "type": "module",
@@ -11,10 +11,11 @@
     "schemas/"
   ],
   "exports": {
-    "./method/": "./src/data/method/",
     "./canvasData.json": "./src/data/canvas/canvasData.json",
     "./localizedData.json": "./src/data/canvas/localizedData.json",
-    "./canvas/": "./src/data/canvas/import-export-templates/"
+    "./method/stations.json": "./src/data/method/stations.json",
+    "./method/resources.json": "./src/data/method/resources.json",
+    "./method/station-criteria.json": "./src/data/method/station-criteria.json"
   },
   "scripts": {
     "test": "node scripts/validate.mjs"

package.json

@@ -10,10 +10,10 @@
   "resource.api-compliance-best-practices.steps": "Dokumentieren Sie die Maßnahmen zur Einhaltung der Vorschriften und stellen Sie sicher, dass sie den Beteiligten und Verbrauchern mitgeteilt werden.",
   "resource.api-compliance-best-practices.tips": "Passen Sie die API-Compliance-Best Practices für Ihre Domäne an",
   "resource.api-development-best-practices.title": "Bewährte Praktiken der API-Entwicklung",
-  "resource.api-development-best-practices.description": "Richtlinien zur Förderung konsistenter, wartbarer API-Codebasen unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und abgestimmten Entwicklungsabläufen.",
+  "resource.api-development-best-practices.description": "Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.",
   "resource.api-development-best-practices.outcomes": "Besseres Verständnis der Grundsätze bewährter Verfahren für die API-Entwicklung",
-  "resource.api-development-best-practices.steps": "Verwendung etablierter Frameworks und Bibliotheken zur Implementierung von APIs, um sicherzustellen, dass sie wiederverwendbar und wartbar sind.",
-  "resource.api-development-best-practices.tips": "Passen Sie die Best Practices für die API-Entwicklung an Ihren Bereich an",
+  "resource.api-development-best-practices.steps": "Wenden Sie diese Vorgehensweisen auf den validierten API-Vertrag und den Implementierungsplan an, bevor mit der Programmierung begonnen wird.",
+  "resource.api-development-best-practices.tips": "Verwenden Sie diese Ressource als Implementierungsleitfaden und als Bewertungsinstrument und nicht als obligatorisches eigenständiges Artefakt", 
   "resource.api-metrics-and-analytics.title": "API-Metriken und -Analysen",
   "resource.api-metrics-and-analytics.description": "Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.",
   "resource.api-metrics-and-analytics.outcomes": "Besseres Verständnis von API-Metriken und Analysegrundsätzen",
@@ -203,7 +203,7 @@
   "resource.api-compliance-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen",
   "resource.api-development-best-practices.outcomes.1": "Standardisierter Ansatz mit bewährten Praktiken für die API-Entwicklung",
   "resource.api-development-best-practices.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken",
-  "resource.api-development-best-practices.steps.1": "Befolgen Sie Kodierungsstandards und bewährte Verfahren, um eine konsistente und hochwertige API-Entwicklung zu gewährleisten.",
+  "resource.api-development-best-practices.steps.1": "Verwenden Sie etablierte Frameworks, Bibliotheken und Codierungsstandards, um den Vertrag konsistent und wartbar zu implementieren.",
   "resource.api-development-best-practices.tips.1": "Gemeinsame Nutzung durch Geschäfts- und Technikfunktionen",
   "resource.api-metrics-and-analytics.outcomes.1": "Standardisierter Ansatz mit API Metrics And Analytics",
   "resource.api-metrics-and-analytics.outcomes.2": "Verbesserte Umsetzung der entsprechenden API-Praktiken",

src/data/canvas/localizedData.json

@@ -12,8 +12,10 @@
   "station.api-consumer-experience.title": "API Consumer Experience - Design für die echten Benutzer Ihrer API",
   "station.api-consumer-experience.description": "Stellen Sie sicher, dass Ihre API auffindbar, verständlich und nutzbar ist - vor und nach der Einführung.",
   "station.api-consumer-experience.why_it_matters": "Großartige APIs funktionieren nicht nur - sie fühlen sich auch intuitiv an. Ganz gleich, ob Ihr Kunde ein interner Entwickler, ein externer Partner oder ein KI-Agent ist, seine Erfahrung entscheidet über die Akzeptanz.\n\nOhne einen klaren Erlebnisplan:\n- Großartige APIs bleiben ungenutzt\n- Teams verschwenden Zeit damit, zu raten, wie sie Ihre API verwenden sollen\n- Feedbackschleifen sind unterbrochen oder fehlen.\n\nDiese Station hilft Ihnen, Ihre API mit den Augen ihrer Nutzer zu sehen.",
- "station.api-consumer-experience.how_it_works": "Ordnen Sie Ihre API-Verbraucher und deren Anforderungen für das Onboarding mithilfe einer Onboarding-Journey-Vorlage oder des Customer Journey Canvas zu.",
- "station.api-consumer-experience.how_it_works.1": "Definieren Sie die API-Consumer-Journey von der Entdeckung bis zur Fehlerbehebung und identifizieren Sie wichtige Berührungspunkte und Schwachstellen.",  "station.api-consumer-experience.apply_in_work": "Bereitstellung von Richtlinien, Tools und Feedback-Mechanismen für das Verständnis, die Analyse und die Verbesserung der internen und externen Erfahrungen von Entwicklern und Partnern.",
+  "station.api-consumer-experience.how_it_works": "Überprüfen Sie das bestehende API Value Proposition Canvаs von der Perspektive des API-Nutzers. Stellen Sie die Stabilität der unterstützten Geschäftsprozesse sicher und ergänzen Sie die Funktionen, die Probleme lösen und Vorteile bieten, um die Bedürfnisse der API-Nutzer zu berücksichtigen, damit diese spätere Designentscheidungen leiten können.",
+   "station.api-consumer-experience.how_it_works.1": "Verwenden Sie das Customer Journey Canvas für die Customer Journey des API-Nutzers von der Entdeckung und Bewertung bis hin zu Onboarding, Integration, Fehlerbehebung und fortlaufender Nutzung.", 
+  "station.api-consumer-experience.how_it_works.2": "Nutzen Sie die daraus resultierende Customer Journey, um Onboarding, Dokumentation, Support und Feedback-Schleifen für den API-Nutzer zu verbessern.",
+  "station.api-consumer-experience.apply_in_work": "Bereitstellung von Richtlinien, Tools und Feedback-Mechanismen für das Verständnis, die Analyse und die Verbesserung der internen und externen Erfahrungen von Entwicklern und Partnern.",
   "station.api-consumer-experience.outcomes": "Identifizieren und priorisieren Sie Ihre API-Kunden",
   "station.api-platform-architecture.title": "API-Plattformarchitektur - Architektur von APIs für Skalierbarkeit und Wiederverwendung",
   "station.api-platform-architecture.description": "Gewährleisten Sie Skalierbarkeit, Wiederverwendung und Governance für Ihre API- und Plattformkomponenten.",
@@ -32,7 +34,7 @@
   "station.api-delivery.why_it_matters": "Selbst die besten API-Designs scheitern, wenn die Bereitstellung uneinheitlich ist. Diese Station stellt sicher, dass Ihre APIs qualitativ hochwertig erstellt, gründlich getestet und zuverlässig bereitgestellt werden - für schnellere Iterationen und mehr Vertrauen.",
   "station.api-delivery.apply_in_work": "Bereitstellung von Kodierungsrahmen, Bibliotheken und Standards für die API-Implementierung. Implementierung von CI/CD-Pipelines, Qualitätssicherungs-Frameworks und Tools zur Automatisierung der Bereitstellung.",
   "station.api-delivery.outcomes": "APIs, die mit getesteten Frameworks und Mustern implementiert werden",
-  "station.api-delivery.how_it_works": "Verwendung etablierter Frameworks und Bibliotheken zur Implementierung von APIs, um sicherzustellen, dass sie wiederverwendbar und wartbar sind.",
+  "station.api-delivery.how_it_works": "Verwenden Sie Best Practices für die API-Entwicklung als Leitfaden für die Implementierung des validierten Vertrags mit etablierten Frameworks und Bibliotheken, um sicherzustellen, dass das Ergebnis wiederverwendbar und wartbar ist.",
   "station.api-audit.title": "API-Audit - Prüfung von APIs auf Konformität und Qualität",
   "station.api-audit.description": "Überprüfen Sie vor der Veröffentlichung, ob APIs den organisatorischen, technischen und rechtlichen Standards entsprechen.",
   "station.api-audit.why_it_matters": "APIs sind langlebige Produkte und müssen die Erwartungen an Qualität, Konsistenz und Compliance erfüllen. Audits verringern Risiken, verhindern, dass Mängel in die Produktion gelangen, und unterstützen externe Zertifizierungen.",
@@ -204,7 +206,7 @@
   "station.api-product-strategy.outcomes.1": "Gemeinsame Sprache zwischen Produkt, Design und Technik",
   "station.api-product-strategy.outcomes.2": "Ein solides Argument für die Finanzierung/Bewilligung",
   "station.api-product-strategy.how_it_works.1": "Definieren Sie zentrale Entitäten, ihre Attribute und Beziehungen, um ein gemeinsames konzeptionelles Verständnis für alle Journeys und eventuell APIs zu schaffen.",
-  "station.api-product-strategy.how_it_works.2": "Identifizieren Sie die Bedürfnisse der Entwickler und neue oder wiederverwendbare APIs mithilfe des API Value Proposition Canvas.",
+  "station.api-product-strategy.how_it_works.2": "Verwenden Sie das API Value Proposition Canvas, um die unterstützten Geschäftsaufgaben sowie die Probleme, Vorteile und Funktionen für API-Nutzer zu erfassen, die neue oder wiederverwendbare APIs prägen.",
   "station.api-product-strategy.how_it_works.3": "Definieren Sie den Wert - für die Nutzer und das Unternehmen - mit dem API Business Model Canvas, um Ihre API-Strategie visuell, gemeinsam nutzbar und einfach mit Ihren API-Kunden an der nächsten Station zu validieren.",
   "station.api-consumer-experience.outcomes.1": "Definieren Sie die API-Erlebnisreise",
   "station.api-consumer-experience.outcomes.2": "Onboarding, Dokumentation und Feedback planen",
@@ -221,12 +223,13 @@
   "station.api-design.how_it_works.2": "Wenden Sie REST-Entwurfsmuster an, um konsistente, wiederverwendbare API-Verträge zu erstellen, die mit den Beteiligten validiert werden.",
   "station.api-design.how_it_works.3": "Wenden Sie ereignisgesteuerte Entwurfsmuster an, um konsistente, wiederverwendbare API-Verträge zu erstellen, die mit den Beteiligten validiert werden.",
   "station.api-design.how_it_works.4": "Wenden Sie GraphQL-Designmuster an, um konsistente, wiederverwendbare API-Verträge zu erstellen, die mit den Beteiligten validiert werden.",
-  "station.api-design.how_it_works.5": "Nutzen Sie die Erkenntnisse, um APIs zu entwickeln, die den Bedürfnissen der Verbraucher entsprechen, und stellen Sie sicher, dass sie auffindbar, verständlich und nutzbar sind.",
-  "station.api-design.how_it_works.6": "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.",
+  "station.api-design.how_it_works.5": "Nutzen Sie die Designprinzipien und die REST-API-Designrichtlinien, um das protokollspezifische Design so zu verfeinern, dass es nutzbar, verständlich und konsistent bleibt.",
+  "station.api-design.how_it_works.6": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um den API-Vertrag vor der Implementierung zu erfassen und zu validieren.",
+  "station.api-design.how_it_works.7": "Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass das API-Design funktionale und nicht-funktionale Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.",
   "station.api-delivery.outcomes.1": "Zuverlässige und automatisierte CI/CD-Pipelines",
   "station.api-delivery.outcomes.2": "Funktionale und nicht-funktionale Tests integriert",
   "station.api-delivery.outcomes.3": "Sichere und gesetzeskonforme Zustellungspipelines",
-  "station.api-delivery.how_it_works.1": "Wenden Sie Contract-First- oder Design-First-Ansätze an, um sicherzustellen, dass API-Verträge vor der Implementierung validiert werden.",
+  "station.api-delivery.how_it_works.1": "Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.",
   "station.api-delivery.how_it_works.2": "Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.",
   "station.api-delivery.how_it_works.3": "Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.",
   "station.api-delivery.how_it_works.4": "Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.",

src/data/method/de/labels.resources.json

@@ -22,13 +22,13 @@
   "resource.api-compliance-best-practices.tips": "Customize the API Compliance Best Practices for your domain",
   "resource.api-compliance-best-practices.tips.1": "Use it collaboratively across business and tech roles",
   "resource.api-development-best-practices.title": "API Development Best Practices",
-  "resource.api-development-best-practices.description": "Guidelines promoting consistent, maintainable API codebases using standard libraries, reusable patterns, and aligned development workflows.",
+  "resource.api-development-best-practices.description": "Implementation guidance for turning a validated API contract into a consistent, maintainable API codebase using standard libraries, reusable patterns, and aligned development workflows.",
   "resource.api-development-best-practices.outcomes": "Better understanding of API development best practices principles",
   "resource.api-development-best-practices.outcomes.1": "Standardized approach using API Development Best Practices",
   "resource.api-development-best-practices.outcomes.2": "Improved implementation of related API practices",
-  "resource.api-development-best-practices.steps": "Use established frameworks and libraries to implement APIs, ensuring they are reusable and maintainable.",
-  "resource.api-development-best-practices.steps.1": "Follow coding standards and best practices to ensure consistent and high-quality API development.",
-  "resource.api-development-best-practices.tips": "Customize the API Development Best Practices for your domain",
+  "resource.api-development-best-practices.steps": "Apply these practices to the validated API contract and implementation plan before coding begins.",
+  "resource.api-development-best-practices.steps.1": "Use established frameworks, libraries, and coding standards to implement the contract consistently and maintainably.",
+  "resource.api-development-best-practices.tips": "Use this resource as implementation guidance and a review lens rather than as a required standalone artifact",
   "resource.api-development-best-practices.tips.1": "Use it collaboratively across business and tech roles",
   "resource.api-metrics-and-analytics.title": "API Metrics And Analytics",
   "resource.api-metrics-and-analytics.description": "A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes.",
@@ -404,4 +404,4 @@
   "resource.rest-canvas.tips": "Use standard HTTP methods (GET, POST, PUT, DELETE)",
   "resource.rest-canvas.tips.1": "Ensure resource URIs are intuitive and consistent",
   "resource.rest-canvas.tips.2": "document error handling and response codes"
-}
+}