#dokumentation

DevOps Stories: Cloud bedeutet nicht NoOps

Das MusicStore-Team hat vor einigen Wochen ein paar neue Funktionen am Recommender live geschaltet. Durch diese Änderung sollen die Kunden bessere Vorschläge erhalten, welche Musik für sie interessant sein könnte. Manuela, die sich um den Support für MusicStore kümmert, wendet sich an die Kollegen im Raum.

Ganz unkompliziert: So werden Code-Dokumentation richtig geschrieben

Manchmal wird es zum Projektende noch einmal richtig zäh. Dann muss eine Dokumentation geschrieben werden, die vielleicht nie jemand liest und wenn doch vielleicht nicht versteht. Das geht auch anders. Mit drei einfachen Regeln und einer passenden Teamkultur lässt sich die Dokumentation ohne Anstrengung in die Entwicklungsarbeit integrieren.

Code-Dokumentation: Wettbewerbsvorteil statt Zeitfresser

Allein das Wort „Dokumentation“ führt bei vielen Entwicklern schon zu angestrengtem Stirnrunzeln. Wenn Dokumentation den Spaß an der Arbeit raubt, zur reinen Pflichterfüllung verkommt oder gar darauf verzichtet wird, ist es an der Zeit, sich mit einer besseren Herangehensweise auseinander zu setzen. Als Belohnung winken Zeitersparnis, höhere Qualität und weniger Frust.

„CODEDOC unterstützt eine erweiterte Syntax für Markdown, wodurch individuelle strukturelle Komponenten verwendet werden können“

CODEDOC hilft dabei, Dokumentationen für Open-Source-Projekte zu schreiben und zu veröffentlichen. Dafür wird einfaches Markdown verwendet, das um eigene Komponenten ergänzt werden kann. Wie der Entwickler des Projekts, Eugene Ghanizadeh, im Interview erklärt, können Entwickler das Ergebnis so ganz individuell gestalten.

Abwärtskompatible APIs in der Praxis

Wenn ein API erst einmal live ist, ist es nicht mehr so einfach, es zu ändern. Doch jede noch so gut definierte Schnittstelle kommt irgendwann an den Punkt, an dem sie weiterentwickelt werden muss; sei es nur, weil sich die Anforderungen geändert haben. Hier kommt die Abwärtskompatibilität in Spiel. Arne Limburg erklärt in seiner Session auf der JAX 2019, welche Herausforderungen bei APIs zu bewältigen sind.

COVID-19: Code-Dokumentation ist unerlässlich, aber es gibt eine bessere Variante

Warum dokumentieren Programmierer ihren Code nicht? In einer aus Homeoffice und Remote-Work bestehenden Arbeitsumgebung ist die Dokumentation ein weiteres wesentliches Werkzeug, um die Koordination des Teams aufrechtzuerhalten. Dies ist ein guter Zeitpunkt, um noch einmal zu reflektieren, wie wir über Dokumentation und ihren Wert denken. Die gute Nachricht vorweg: Es gibt einen besseren Weg.

Wie Sie Dokumentationen in einer Microservices-Landschaft generieren

Eine gute Dokumentation gilt als Aushängeschild eines Systems. Doch meist wird sie als notwendiges Übel betrachtet und daher viel zu oft vernachlässigt. Dabei ist eine lückenhafte und veraltete Dokumentation ein risikobehafteter Bereich mit viel Konflikt- und Fehlerpotenzial. Um die Risiken zu vermeiden, haben wir uns auf die Suche nach einer dynamischen und flexiblen Lösung gemacht. Die Ergebnisse stellen wir euch hier vor.

Codeübernahme von externen Teams

Wie geht ein neu zusammengestelltes Software-Entwicklungsteam vor, das in einem definierten Zeitraum eine unbekannte Codebasis von einem anderen Team in einer anderen Stadt übernehmen soll? In genau dieser Situation befand ich mich mit einem Team bei ImmobilienScout24. Dieser Artikel beschreibt, wie mein Team mit dieser Herausforderung umging und am Ende erfolgreich die bestehende Anwendung pflegte und erweiterte.

Ein Dokumentations-Browser für Entwickler: Zeal stellt sich vor

Die Zahl von Programmiersprachen, Frameworks, Datenbanken und APIs, die Entwickler handhaben müssen, um wettbewerbsfähige Projekte starten zu können, wächst stetig. Mit dem großen Boom an Optionen wurden auch neue Management- und Produktivitätswerkzeuge geschaffen. Der Markt bietet derzeit mehrere Organizer für APIs, Syntax- und Rahmendokumentationen und alle Arten von book shops oder libraries. Neben Dash und DevDocs scheint nun auch Zeal ein weiterer Haupt-Organzier zu sein.

X
- Gib Deinen Standort ein -
- or -