CARDS+

Tag: Dokumentation (page 2 of 8)

Was beschreibt der Baustein Spec?

Agile Software-Entwicklung hat uns von einigen Zwängen der phasen-orientierten Prozesse befreit.

  • Wir müssen nicht mehr alles zu Beginn des Projektes wissen. Wir dürfen miteinander und voneinander lernen.
  • Wir haben keine getrennten Teams für Analyse, Entwicklung und Test. Wir lieben selbstorganisierte cross-funktionale Teams.
  • Niemand muss in einer Software-Fabrik arbeiten. Wir reden miteinander und entwickeln das unserer Meinung beste Produkt.

Trotzdem gibt es in agilen Prozessen den Bedarf für Anforderungsanalyse, Stakeholder-, Architektur- und Lizenzmanagent, auf jeden Fall in großen Unternehmen. Eine agile Projektorganisation bewegt sich immer in einem Spannungsfeld zwischen Selbstorganisation der Entwickler, verbunden mit der vollständigen Kontrolle über die Implementierung ihrer Komponenten, und der Einschränkung der Vielfalt der Lösung aufgrund übergreifender Ziele, internationaler Normen oder unternehmensweiter Vorgaben. Immer kontrovers!

Continue reading

Lesbarer Code ist besser als Dokumentation.

Continue reading

Umgebungsübersicht

In einem IT-System ist jede Komponente ein Knoten in einem mehr oder weniger komplexen Netzwerk. Eine Umgebungsübersicht ist ein zentraler Anlaufpunkt für die Betriebsorganisation, aber auch für Entwickler und Tester. Sie beinhaltet Informationen über die Version jeder Komponente, welche Komponente wie oft als Instanz existiert, wie viel Speicher sie verwendet oder wie ihr aktueller Zustand ist. Abhängig von der gewählten Architektur zeigt so eine Übersicht noch viele weitere Merkmale.

Continue reading

Betriebsanweisungen

Es ist offensichtlich, dass ein Restaurant wesentlich effektiver (also gewinnbringender) funktioniert, wenn Köche und Kellner ihre Aufgaben beherrschen und gut zusammenarbeiten. Sowohl Koch als auch Kellner haben Aufgaben, die sie wiederholt ausführen. Der Koch muss die Erwartungen der Gäste des Restaurants erfüllen und die Speisen so zubereiten, wie sie in der Speisekarte stehen. Der Kellner muss wissen, wie er einen Tisch eindeckt und wie er Getränke und Speisen serviert. Das Konzept der DevOps überträgt diese Gedanken auf die agile Software-Entwicklung. Product-Owner (Chefkoch) und das cross-funktionale Scrum-Team (Entremetier, Gardemanger, Pâtissier und Saucier) liefern ein Produkt (Speisen). Die Betriebsorganisation (u.a. Kellner) definiert Qualitätsanforderungen, achtet auf die Einhaltung der Qualität des Produktes und macht es für die Nutzer (Gäste) verfügbar.

Continue reading

Confluence-Tip Seitentitel mit Präfix

Aus eigener Erfahrung wird ein Gärtner regelmäßig mit der Frage konfrontiert, ob im Seitentitel das Präfix für den Baustein wirklich notwendig ist. Das Präfix ist in erster Linie eine Kennzeichnung, ein Stereotyp. Es zeigt an, welcher Baustein die Grundlage für diese Seite ist, welcher Aspekt in der Seite behandelt wird.

ktip Ein Stereotyp (englisch: stereotype) ist eine Erweiterung vorhandener Modellelemente in der Unified Modeling Language (UML). In der Praxis geben Stereotype vor allem die möglichen Zusammenhänge bei der Verwendung (Verwendungskontext) einer Klasse, einer Beziehung oder eines Paketes an.

Ähnlich wie bei UML-Diagrammen haben wir in einer technischen Dokumentation Modellelemente: Im Wiki sind es Seiten. Seiten bieten für alle gleiche Grundfunktionen, bestehend aus neun Überschriftenebenen, drei Absatzformaten (normal, für Code, für ein Zitat) und kombinierbaren Schriftstilen (fett, kursiv, unterstrichen, durchgestrichen).

Continue reading

Confluence-Tip Seitenhierarchie löschen

Der Hersteller von Confluence scheint offensichtlich anzunehmen, dass Löschen von Seiten mit vielen Unterseiten oder einer Seitenhierarchie mit mehreren Ebenen in der Praxis recht selten vorkommt. Nur so kann ich mir erklären, dass Confluence erst seit kurzer Zeit eine entsprechend erweiterte Standardfunktion bietet.

Ein in der Praxis erprobtes Verfahren für das Löschen von beliebig großen Seitenhierarchien nutzt andere Standardfunktionen von Confluence und schafft Abhilfe, wo die neue Standardfunktion noch nicht verfügbar ist.

Bereiche sind die Methode von Confluence, Inhalte in sinnvolle Einheiten zu organisieren. Das Anlegen eines Bereiches (Space) geht einfach und schnell, erfordert aber besondere Rechte.

Weiterlesen auf atlassian.com

Jeder Bereich (Space) kann in den Formaten XML, HTML oder PDF exportiert werden. Die Durchführung dieser Operation erfordert aber besondere Rechte.

Nur ein XML-Export kann aber später wieder importiert werden.

Weiterlesen auf atlassian.com

Ein Bereich (Space) kann mit allen Inhalten gelöscht werden. Diese Operation ist aber endgültig und erfordert besondere Rechte.

Weiterlesen auf atlassian.com

Bereiche (Spaces), die als XML-Export vorliegen, können wieder importiert werden. Die Durchführung dieser Operation erfordert aber besondere Rechte.

Weiterlesen auf atlassian.com

Eine Seite wird in Confluence verschoben, indem die übergeordnete Seite geändert wird. Anders als beim Löschen einer Seiten werden mit der Seite auch alle Unterseiten verschoben.

Weiterlesen auf atlassian.com

Continue reading

Olderposts Newerposts

Copyright © 2018 Impressum Datenschutz

Zum Anfang ↑