Erstellen und pflegen Sie schnell Dokumentationen über Ihren Code oder die von Ihnen entwickelten Funktionen!

Erfahren Sie, wie Alex Docs genutzt hat, um seinem Team zu ermöglichen, Funktionen schneller zu verbessern.

Treffen Sie Alex

Alex ist ein leitender Entwickler bei einem Cloud-basierten Softwareunternehmen. Sie entdecken, dass einige Features nur sehr begrenzt dokumentiert sind.

Alex stellt fest, dass das Team viel Zeit damit verbringt, direkt aus dem Code ihrer Software zu untersuchen, wie Funktionen funktionieren. Das verlangsamt die Fähigkeit des Teams, bestehende Features zu verbessern.

Die Herausforderung

Die Produkt- und Engineering-Teams arbeiten nach einem sehr straffen Zeitplan, um Funktionen in das Produkt einzuführen. Die Entwickler haben sehr begrenzte Zeit, um Dokumentationen über neue Funktionen zu erstellen.

Das Team hat keine Zeit, die Dokumentation zu pflegen, da ein Feature über die Zeit verbessert wird und Fehler behoben werden.

Einige neuere Entwickler sind frustriert über den Mangel an Dokumentation. Es fällt ihnen schwer, das Produkt effektiv kennenzulernen.

Andere Entwickler haben das Gefühl, mehr Zeit mit Antworten auf Fragen zu verbringen, statt Probleme zu lösen und besseren Code zu schreiben.

Die Lösung

Alex arbeitet daran, ein Feature zu verbessern, das keine gute Dokumentation hat. Sie beschließen, ein ClickUp-Dokument mit Informationen über das Feature zu erstellen, das als Referenzmaterial für andere Entwickler dient.

Erstelle die Struktur des Dokuments und der Seite

Alex beschließt, dass jedes Feature sein eigenes Dokument haben soll. Wenn das Team an einem Feature arbeitet, sind alle relevanten Informationen in einem einzigen Dokument zusammengefasst.

Die Verwendung von Seiten innerhalb eines Dokuments ermöglicht es dem Team, relevante Antworten schnell zu finden, ohne nach separaten Dokumenten zu suchen und diese zu durchsuchen.

Alex erstellt einige Seiten im Dokument, um den Inhalt basierend darauf zu strukturieren, was das Team wissen muss und wonach es möglicherweise sucht.

1. Produktzusammenfassung

2. Front end code

3. Backend-Code

4. Infrastruktur

5. Mobile App

6. Testen und Qualitätssicherung

7. FAQ und Fehlerbehebung

Tipp: Suchen Sie mit der Suchfunktion nach spezifischen Seiten oder Inhalten innerhalb eines Dokuments!

Überschriften

Unter jeder Seite stellt Alex Überschriften ein, damit das Entwicklungsteam weiß, welche Informationen wohin gehören.

Produktzusammenfassung

• Kurzbeschreibung des Produkts

• Funktionsübersicht

• Anwendungsfälle

• UI-Design

Frontend

• UI-Elemente

• Stile

• Tooltips

Back End

• API-Routen

• Datenbankschema

Mobilgeräte

• iOS

• Android

Testen und Qualitätssicherung

• Akzeptanzkriterien

• QA-Automatisierungstests

Formatierung

Alex nutzt eine Kombination der verfügbaren Formatierungsoptionen in ClickUp-Dokumenten, um seiner Dokumentation ein einheitliches Aussehen und Gefühl zu verleihen.

Inline-Code und Codeblöcke

Alex verwendet Backticks ( `` ), um Text als Inline-Code zu formatieren, um einzelne Codezeilen darzustellen, wie im folgenden Beispiel gezeigt:

Für größere Code-Snippets verwendet Alex die Formatierung von Codeblöcken ( /co ), wie unten gezeigt:

Formatierungsoptionen für Codeblöcke

Stelle deinen Code Block so ein, dass er die Sprache deiner Wahl verwendet!

1. Fahren Sie über die obere rechte Ecke

2. Wählen Sie Ihre bevorzugte Sprache aus

Inhalte verlinken und einbetten

Jetzt enthält Alex' Dokument Text, einige Screenshots und hilfreiche Code-Snippets.

Es sieht gut aus, aber die Produktübersicht ist noch leer.

Das Produktteam verwendet Figma, um das Benutzerinterface zu entwerfen und zu strukturieren. Alex verwendet den /Slash-Befehl /figma, um das aktualisierte Design des Features direkt in die Seite mit der Produktübersicht einzubetten.

Alex verwendet @@ erwähnen, um auf die Epic Aufgabe auf der Roadmap des Teams zu verlinken.

Erstelle eine Vorlage

Alex speichert das Dokumentenlayout als Vorlage, sodass das Team schnell und einfach ein Dokument mit den Unterseiten und Überschriften für andere Funktionen erstellen kann.

1. Klicken Sie auf das Dokumenteinstellungen-Symbol in der rechten Seitenleiste

2. Wählen Sie Als Vorlage speichern

Alex füllt ein Beispiel-Dokument mit der Vorlage aus, damit das Team eine erstklassige Dokumentation als Beispiel verwenden kann.

Alex erstellt ein neues Dokument basierend auf der Vorlage, füllt es aus und teilt es mit dem Team.

Proof of Concept

Alex präsentiert das Konzept der Dokumentvorlage dem Engineering-Team beim nächsten Team-Meeting. Die anderen Entwickler lieben Alex' detailliertes Beispiel für Dokumentation!

Das Team macht sich Sorgen darüber, wie lange es dauern könnte, die Details auszufüllen. Alex fordert sie auf, ein Feature auszuwählen, damit sie allen zeigen können, wie schnell man Dokumentation erstellen kann.

Das Team entscheidet über ein Feature. Alex erstellt ein Dokument, wendet die Vorlage mit dem Slash-Befehl /temp an und gibt den Link für alle Teilnehmer des Gesprächs frei.

Ein paar Entwickler springen ein und beginnen, das Dokument gemeinsam mit Alex zu bearbeiten. Jeder füllt die Seiten und Abschnitte aus, mit denen er am besten vertraut ist.

Das gesamte Team ist angenehm überrascht, als es nach nur 20 Minuten einen ziemlich umfassenden Entwurf der Dokumentation erstellt hat.

Das Ergebnis

Das Team stimmt zu, Alex' Vorlage und Dokumentation einen Testlauf zu geben. Im nächsten Sprint füllen einige Entwickler 30 Minuten lang die Dokumentation für das Hauptfeature aus.

Die Dokumentation ist noch nicht ganz fertiggestellt. Es gibt eine grobe Skizze, die gerade genug Details enthält, um anderen Entwicklern zu helfen, das Feature zu verstehen und zu verbessern.

Nach einigen Wochen ist das Schreiben von Dokumentationen zu einem wichtigen Teil der Aufgaben des Engineering-Teams geworden.

Mit einigen Anpassungen und Verbesserungen an Alex' Vorlage verringert sich die Zeit, die für das Erstellen und Pflegen der Dokumentation aufgewendet wird.

Alex führt eine Umfrage durch und stellt fest, dass:

• Neue Entwickler fühlen sich sicherer im Umgang mit dem Code, wenn Dokumentation verfügbar ist

• Erfahrene Entwickler bemerken weniger Fragen von ihren Kollegen und Kundensupport-Teams

Das ist ein großer Erfolg für das Team der Ingenieure! Bei einem Ereignis im Team wird Alex der Ehrentitel "Resident Librarian und Hüter des Wissens" verliehen.