DevDocs – Plattform für technische Dokumentation

Einführung in DevDocs

• DevDocs ist eine Website, die verschiedene API-Dokumentationen in einer schnellen, strukturierten und durchsuchbaren Oberfläche bündelt.
• Nutzer können über Einstellungen weitere Dokumentationen aktivieren und die UI anpassen.
• Die Website lässt sich auch ohne Maus effizient per Tastaturkürzel bedienen.

Suchfunktion

• Die Suche unterstützt Fuzzy-Matching; gibt man zum Beispiel „bgcp“ ein, erscheint „background-clip“.
• Um eine bestimmte Dokumentation zu durchsuchen, gibt man den Namen oder die Abkürzung der Doku ein und drückt dann die Tab-Taste.
• Man kann auch lernen, wie man die Suche über die Adressleiste des Browsers nutzt.

Weitere Informationen

• DevDocs funktioniert auch offline, ist auf Mobilgeräten nutzbar und kann als Web-App installiert werden.
• Um Neuigkeiten zu erhalten, kann man @DevDocs folgen.
• DevDocs ist kostenlos und als Open Source verfügbar.
• Für Menschen, die gerade erst mit dem Programmieren anfangen, wird empfohlen, sich das Open-Source-Curriculum von freeCodeCamp anzusehen.

Meinung von GN⁺

• DevDocs ist ein unverzichtbares Tool für Entwickler, weil sich Dokumentationen zu verschiedenen Programmiersprachen und Frameworks an einem Ort leicht finden lassen.
• Die Tastaturkürzel und die Fuzzy-Matching-Suche sind wichtige Funktionen, die die Effizienz von Entwicklern steigern.
• Offline-Zugriff und mobile Kompatibilität machen DevDocs noch nützlicher, da Nutzer so überall auf Informationen zugreifen können.

[GN⁺]

Hacker-News-Kommentare

• Meinung eines der Maintainer:

  • Dokumentations-Updates für neue Releases sind einfach, solange das Dokumentationssystem oder Design nicht neu geschrieben wird.
  • Einige Projekte ändern ihr Dokumentationssystem regelmäßig.
  • Der Dokumentationsgenerator erzeugt zufällige Klassennamen, was das Aufräumen der Dokumentation umständlich macht.
  • Jeden Monat wird automatisch eine Liste veralteter Dokumentationen erstellt, und dabei wird Hilfe benötigt.

• Meinung eines Nutzers, der den Blogbeitrag über Offline-Dokumentation erneut besucht hat:

  • Er fragt sich, ob es Technologien gibt, die den Konsum von Dokumentation offline erleichtern.
  • Er fragt, ob es ein standardisiertes Format gibt oder ob ihm noch etwas unbekannt ist.

• Meinung eines Nutzers, der vor einer Fernreise seine Checkliste prüft:

  • Er teilt ein Tool, mit dem sich Sprach- und API-Dokumentation offline leicht aufrufen lassen.
  • Er plant Entwicklung mit Zig und Vulkan.

• Meinung eines Nutzers, der es beim Programmieren unterwegs als nützlich empfunden hat:

  • Besonders nützlich, wenn das WiFi instabil ist.
  • Wenn man Dokumentation zusammenführt und zu einer einzigen standardisierten Oberfläche macht, würde das die Produktivität stark verbessern.

• Meinung eines Nutzers, der überrascht ist, dass ein grundlegendes Bedürfnis von Programmierern systemisch nicht erfüllt wurde:

  • devdocs enthält keine Bibliotheken, die er regelmäßig verwendet.
  • Er hat Dash ausprobiert, konnte die OpenAI-Dokumentation aber nicht direkt bekommen.

• Meinung eines Nutzers, der dieses Tool während eines 14-stündigen Flugs genutzt und den Tag dadurch produktiv gemacht hat:

  • Sehr nützlich, weil die Dokumentation ohne Ablenkungen Fragen beantworten kann.

• Meinung eines Nutzers über das Offline-CLI-Tool dedoc:

  • Es vermeidet den Kontextwechsel zum Browser, und man kann devdocs über die CLI herunterladen, durchsuchen und lesen.
  • Es ist statisch mit Rust kompiliert, sodass man das Binärprogramm herunterladen und installieren kann.

• Meinung eines Nutzers über ein Open-Source-Tool ähnlich wie Dash:

  • Sehr gut.

• Dank an dieses Tool:

  • Viel besser als Websuchmaschinen, wenn man Ergebnisse nur in der offiziellen Dokumentation finden möchte.
  • Er plant, es lokal zu kopieren und auszuführen oder selbst zu hosten.

• Meinung eines Nutzers, der dieses Tool täglich über ein Emacs-Paket verwendet:

  • Im Vergleich zu Lösungen wie Dash ist der Workflow deutlich flüssiger.