Mittwoch , September 16 2020

Aufbau eines besseren Entwicklerdokumentationsportals

Blog

Die Entwicklung von Analyse-Apps ist eine neue Richtung für Produktteams. In der Toolbox sprechen wir über Best Practices, Tipps, Tricks und Erfolgsgeschichten für die Entwicklung, um Ihnen dabei zu helfen, die Zukunft der Analytik zu gestalten und Ihren Benutzern die erforderlichen Erkenntnisse und Aktionen zu vermitteln.

Der neue Sisense-Entwickler Das Portal sieht nicht nur gut aus, es wurde auch von Grund auf für Entwickler entwickelt. Während Sie es erkunden, fragen Sie sich möglicherweise: "Warum haben Sie sich entschieden, in das neue Entwicklerportal zu investieren?" "Was war los mit dem alten?" „Warum hat sich Ihre Zeit und Mühe gelohnt?“

Dies sind alles großartige Fragen, und wir haben viele Antworten für Sie. Um sie zu erhalten, setzte ich mich mit Moti Granovsky, Sisense's Head of Developer Relations (und API-Architekt), zusammen, um die Gründe für das Redesign und die Möglichkeiten zu untersuchen, wie die Verbesserungen das Leben von Entwicklern verbessern, die Sisense in ihre Produkte integrieren möchten. [19659006] Wir haben viel über gesprochen und in diesem Teil des Gesprächs untersuchen wir, warum es wichtig ist, beim Aufbau Ihres Dokumentationsportals einen rein entwicklerorientierten Ansatz zu wählen.

 Must-Have-AI-Funktionen -for-your-app-blog-cta-banner "class =" wp-image-105340 lazyload "data-srcset =" https://cdn.sisense.com/wp-content/uploads/must-have-AI- Funktionen-für-Ihre-App-Blog-cta-Banner-770x250-1.jpg 770w, https://cdn.sisense.com/wp-content/uploads/must-have-AI-features-for-your-app -blog-cta-banner-770x250-1-370x120.jpg 370w, https://cdn.sisense.com/wp-content/uploads/must-have-AI-features-for-your-app-blog-cta- banner-770x250-1-768x249.jpg 768w, https://cdn.sisense.com/wp-content/uploads/must-have-AI-features-for -Ihr-App-Blog-cta-Banner-770x250-1-178x58.jpg 178w, https://cdn.sisense.com/wp-content/uploads/must-have-AI-features-for-your-app- blog-cta-banner-770x250-1-616x200.jpg 616w, https://cdn.sisense.com/wp-content/uploads/must-have-AI-features-for-your-app-blog-cta-banner -770x250-1-356x116.jpg 356w "Größen =" (maximale Breite: 770px) 100vw, 770px "/> </figure>
<h2> Maximierung der größten Schnittstelle mit Entwicklern </h2>
<p><strong> Shruthi Panicker: </strong> Warum war eine Überholung wichtig? das Sisense-Entwicklerportal? </p>
<p><strong> Moti Granovsky: </strong> Die Entwicklerdokumentation ist die Schnittstelle mit der größten Oberfläche, auf der wir als Organisation mit Entwicklern interagieren. Über alles, was wir tun können – Veranstaltungen, Webinare, Blog-Beiträge und alles andere außerhalb des Produkts selbst – ist die Dokumentation der Ort, an dem wir am meisten interagieren. </p>
<p> Jedes Unternehmen, das Entwickler als wichtiges Publikum betrachtet, muss a investieren viel Mühe und Gedanken in dieses Unterfangen. Es ist offensichtlich, dass viele verschiedene Entwickler in verschiedenen Phasen (vor oder nach dem Verkauf), die mit Sisense arbeiten, auf den Dokumentationsseiten landen. Es ist eine Selbstverständlichkeit, und in diese müssen wir weiter investieren. </p>
<h2> Bessere Inhalte bedeuten eine bessere Entwicklererfahrung. </h2>
<p><strong> SP: </strong> Inwiefern hilft eine solche Investition? </p>
<p><strong> MG: </strong> Die Investition in Entwicklerinhalte und in die Website selbst (wie zugänglich sie ist, wie intuitiv sie ist, wie einfach sie zu lesen ist usw.) zahlt sich auf lange Sicht aus Eine verbesserte Perspektive für das Kundenerlebnis sowie Kosteneinsparungen. </p>
<p> Das Generieren von Dokumentationen ist eine einmalige Investition pro Thema, kann jedoch vielen Menschen über Jahre hinweg helfen. Benutzer können sich nur statische Inhalte ansehen und das Wissen erwerben, das sie benötigen, wodurch die Belastung für Supportteams, Lösungsingenieure oder Pre-Sales-Ingenieure verringert wird. </p>
<p> Durch das Erstellen eines Portals, auf das die richtigen Inhalte leicht zugänglich sind, kann die Anzahl der Fragen verringert werden Entwickler, die sich mit Ihrem Produkt befassen. Dies liegt daran, dass Entwickler fast immer zuerst einen schriftlichen Inhalt suchen, bevor sie eine direkte Interaktion suchen, wenn sie ein Problem haben, das sie zu lösen versuchen. </p>
<p> Mehr Dokumentation liefert auch eine bessere Kundenerfahrung, denn selbst wenn ein Entwickler <em> Muss </em>eine Frage stellen, besteht eine gute Chance, dass der interne Mitarbeiter, der mit der Beantwortung beauftragt ist, den Kunden zu einer schriftlichen Ressource weiterleiten kann, die validiert und in einer für alle verständlichen Sprache verfasst wurde. [19659006]  Letztendlich führen bessere Inhalte, auf die leicht zugegriffen werden kann, zu einer besseren Kundenerfahrung.</p>
<figure class= Blog-Embedded-Trends-20191218-bl-Blog-Banner "class =" wp-image-85289 lazyload "data-srcset =" https : //cdn.sisense.com/wp-content/uploads/sisense-blog-Embedded-Trends-20191218-bl-blog-banner1.jpg 770w, https://cdn.sisense.com/wp-content/uploads/ sisense-blog-Embedded-Trends-20191218-bl-blog-banner1-370x120.jpg 370w, https://cdn.sisense.com/wp-content/uploads /sisense-blog-Embedded-Trends-20191218-bl-blog-banner1-768x249.jpg 768w, https://cdn.sisense.com/wp-content/uploads/sisense-blog-Embedded-Trends-20191218-bl- blog-banner1-178x58.jpg 178w, https://cdn.sisense.com/wp-content/uploads/sisense-blog-Embedded-Trends-20191218-bl-blog-banner1-616x200.jpg 616w, https: // cdn.sisense.com/wp-content/uploads/sisense-blog-Embedded-Trends-20191218-bl-blog-banner1-356x116.jpg 356w "Größen =" (maximale Breite: 770px) 100vw, 770px "/> [19659009] Eine gute Dokumentation ist ein Indikator für ein ausgereiftes API-Ökosystem. </h2>
<p><strong> SP: </strong> APIs sind ein wichtiges Werkzeug im Toolkit eines Entwicklers. Wie spielt Dokumentation in die Welt der APIs? </p>
<p><strong> MG: </strong> Wenn die APIs einer Organisation ein Chaos sind und niemand weiß, wie sie funktionieren, ist es wirklich schwierig, sie zu dokumentieren. Das Gegenteil davon ist, wenn jemand ein Produkt kauft und keine gute Dokumentation oder Teilinformationen sieht, dann sagt dies ihm, dass die APIs nicht gut sind. </p>
<p> Sisense hat gute APIs. Wir sind stolz auf sie und möchten, dass die Leute sie nutzen. Um die Vorstellung von der Stärke unserer APIs zu vermitteln, benötigen wir jedoch eine gute Dokumentation. Transparenz, Standards und Konsistenz sind in der API-Dokumentation sofort sichtbar. Wenn man diese Eigenschaften nicht sehen kann, ist es wahrscheinlich schwieriger, die API selbst zu verwenden. </p>
<h2> Entwicklerdokumentation sollte für Beiträge von Entwicklern erstellt werden. </h2>
<p><strong> SP: </strong> Wie unterscheidet sich ein Entwicklerportal vom Rest von unser Inhalt? </p>
<p><strong> MG: </strong> Insbesondere in unserem Fall war unsere Website veraltet: Wir haben ein Content-Management-System (CMS) verwendet, das in Technologieunternehmen sehr verbreitet ist. Unser CMS wurde jedoch ausgewählt, weil es für die Personen zugänglich war, die anfangs Dokumentationen verfasst haben, hauptsächlich für Produktmanager und technische Redakteure, die keine Entwickler sind und einen WYSIWYG-Benutzer (What-You-See-Is-What-You-Get) bevorzugen Schnittstellenbasierter Editor. Sie würden Inhalte so schreiben, wie sie es für White Papers, Blogs usw. tun würden. Für diesen Bedarf erledigte ein White-Label-Content-Management-System mit einigen ästhetischen Verbesserungen die Aufgabe. Außerdem war ein weiß beschriftetes CMS im kleinen Maßstab schnell zusammenstellbar und einfach. </p>
<blockquote class=

Für Entwickler ist ein WYSIWYG-Editor nicht unbedingt der beste Ansatz .

Da es sich um Entwicklerdokumentation handelt, ist die Der Großteil des Inhalts sollte von den Entwicklern erstellt werden, die die APIs erstellen, und nicht von technischen Redakteuren oder Produktmanagern.

Entwicklerinhalte eignen sich nicht wirklich für Veröffentlichungen im Artikelstil .

Es gibt bestimmte Layouts Sehr häufig im Bereich der technischen Dokumentation, insbesondere wenn es sich um API-Referenzen handelt. APIs wiederholen sich. Das manuelle Eingehen und Schreiben – das Aufnehmen einer Reihe von Überschriften und das Festlegen einer bestimmten Größe und Farbe in einem Editor, den Sie sehen, ist was Sie erhalten – ist zeitaufwändig und fehleranfällig.

Sagen Sie Eine API hat 60 Funktionen und man muss den Stil für 60 Header manuell bearbeiten. Dieser Prozess kann nicht skaliert werden. Außerdem können Sie in einem CMS Inhalte nicht einfach automatisch generieren, da normalerweise alles auf der Benutzeroberfläche basiert (oder eine proprietäre Sprache / Syntax für einen programmatischen Ansatz hat).

Die Entwicklerdokumentation ist mehrknotig und nicht hierarchisch ].

Die ursprüngliche Website wurde von technischen Redakteuren erstellt, die sich auf die Produktdokumentation konzentrierten, wobei Sie die Dokumentation als einen Großteil der Informationen, eine Hierarchie von Artikeln, betrachten. Die Entwicklerdokumentation ist anders: Sie ist nicht hierarchisch. Es ist ein Multi-Node. Sie können nicht alle Informationen auf einer Seite zusammenfassen.

Beispielsweise müssen API-Referenzen immer von schriftlichen Tutorials getrennt werden. Als Entwickler, der eine API lernt, möchte ich das Tutorial lesen, das mich durch die Verwendung führt. Als jemand, der die API kennt und die API für die Entwicklung verwendet, möchte ich einen Ort, an dem ich eine interessierte Funktion nachschlagen kann in und suchen Sie die relevanten Parameter. Ich möchte auch nicht durch Inhaltsseiten scrollen, um eine Funktion und ihre Parameter zu finden.

Besser zusammenbauen

Das Erstellen eines neuen Entwicklerportals ist ein wesentlicher Bestandteil, um der Sisense-Entwicklergemeinde die Tools zur Verfügung zu stellen, die sie benötigen mehr erstaunliche Dinge mit Sisense. Alles am neuen Sisense-Entwicklerportal soll Entwicklern aller Art helfen, Inhalte und Informationen zu finden und zu teilen, die allen helfen. Wenn wir zusammen bauen, gewinnt jeder. Lesen Sie unbedingt Teil zwei unseres Interviews mit Moti, um zu sehen, wie wir unsere Community stärken.

Shruthi Panicker ist Senior Technical Product Marketing Manager bei Sisense. Sie konzentriert sich darauf, wie Sisense genutzt werden kann, um erfolgreiche Embedded Analytics-Lösungen zu entwickeln, die die Einbettungs- und Anpassungsfunktionen von Sisense, die Initiative für Entwicklererfahrungen und die Cloud-native Architektur abdecken. Sie hat einen BS in Informatik sowie einen MBA und verfügt über mehr als ein Jahrzehnt Erfahrung in der Technologiewelt.

About BusinessIntelligence

Check Also

Management-Software für klinische Studien und Bewältigung der Herausforderungen der Branche

Es ist kein Geheimnis, dass Unternehmen, die klinische Studien durchführen, es nicht immer eilig haben, …

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.