Contact salesFree trial
Blog

Wie man eine gute Dokumentation erstellt und verwaltet - Podcast

Symfonyoffene QuellePodcast
Teilen Sie

Unsere allererste Folge des Change Mode Podcasts beginnt mit einem wunderbaren Gast aus dem Symfony Core Team, Ryan Weaver. Der Leiter der Symfony-Dokumente und SymfonyCasts-Autor hält uns alle in Schach, wenn es um die Symfony-Entwicklung geht. In dieser Folge erzählt Ryan, wie man in die Open-Source-Entwicklung einsteigt, wie er gute Dokumentationen und Screencasts erstellt und verwaltet (einschließlich der gefürchteten Übersetzungen) und wie man Open-Source und Familienleben unter einen Hut bringt.

Spenden Sie auf Ryans GoFoundMe-Seite, um ihn in seinem Kampf gegen den Krebs zu unterstützen.


Podcast-Transkription

Wir haben ChatGPT verwendet, um die Grammatik und Syntax des Transkripts zu verbessern.

Ryan: Ich arbeite im Kernteam des Symfony Frameworks. Symfony ist ein PHP-Framework, das zur Erstellung von Webanwendungen verwendet wird, aber auch aus unabhängigen Bibliotheken besteht. Selbst Leute, die Symfony nicht direkt verwenden, wie diejenigen, die mit Drupal oder Laravel arbeiten, profitieren von seinen Komponenten.

Ich konzentriere mich sehr auf die Dokumentation und erstelle Tutorials für SymfonyCasts, die Screencasting-Seite für Symfony. Ich trage auch zu anderen Teilen des Open-Source PHP- und Symfony-Ökosystems bei.

Marine: Schön. Daran bin ich interessiert. Wie haben Sie angefangen, im Open-Source-Bereich zu arbeiten? War es ein Zufall oder ein entscheidender Moment?

Ryan: Normalerweise ist es für jeden eine Art Zufall.

Marine: Ja, normalerweise seilt dich jemand ab.

Ryan: Ganz genau. Vor langer Zeit habe ich Blogposts über Symfony geschrieben, weil man das als Nerd eben so macht, wenn man etwas herausfinden will. Als Symfony 2 herauskam, war es eine große Überarbeitung. Der Hauptentwickler, Fabien, brauchte jemanden, der die Dokumentation schreibt. Irgendwie wurde er durch meine Blogbeiträge auf mich aufmerksam und fragte mich, ob ich die Dokumentation für Symfony 2 schreiben wolle. Natürlich habe ich ja gesagt. Im Nachhinein war er wahrscheinlich erleichtert, die Aufgabe an jemand anderen zu übergeben.

Die Marine: Erstaunlich. Es war also Fabien Potencier, der dich gefragt hat.

Ryan: Ja, im Englischen sagen wir "voluntold". Du bist kein Freiwilliger, sondern jemand sagt dir freiwillig, dass du es tun sollst.

Marine: Schlau. Es ist seine Schuld.

Ryan: Ja.

Marine: Okay, zur Kenntnis genommen.

Ryan: Und dann wird es zum Schneeballsystem.

Marine: Ganz genau. Man fängt mit einer Kleinigkeit an und dann wird man dafür bekannt. Dann ist es zu spät.

Ryan: Jepp. Und dann wird man aufgeregt, weil man es weiß.

Marine: Sie haben also bereits einen Beitrag geleistet, indem Sie Blogbeiträge geschrieben haben. Ist das kein Open-Source-Beitrag?

Ryan: Doch, das ist ein Open-Source-Beitrag. Das sollte ich mir merken, denn viele Leute fragen, wie sie zu Open Source beitragen können, und denken, es ginge nur um Code. Aber das ist nicht immer einfach, vor allem bei etwas so Robustem wie Symfony. Manchmal kann ein Beitrag so einfach sein wie das Posten von Lösungen in Ihrem Blog oder in den sozialen Medien. Ich wünschte, wir hätten mehr Leute, die das tun, weil es der Gemeinschaft hilft.

Marine: Ja, das ist etwas, das ich an PHP und Drupal liebe. Man kümmert sich nicht nur um den Code, sondern auch um jede Art von Beitrag, wie die Dokumentation, die oft übersehen wird, aber so hilfreich ist. Sie ist der Einstiegspunkt für neue Leute. Wenn Sie einen Blogbeitrag schreiben, machen Sie Open Source. Schön für Sie.

Ryan: Dieser Blogbeitrag kann aus einem Absatz und zwei Codeblöcken bestehen.

Marine: Ja, die Hauptakteure finden manchmal Lösungen in ihren alten Blogeinträgen. Das ist auch für Sie hilfreich.

Ryan: Ganz genau.

Marine: Also, Blogposts, dann die Dokumentation für Symfony 2, das muss eine riesige Aufgabe gewesen sein. Hatten Sie Hilfe? Wie hat es funktioniert?

Ryan: Am Anfang nicht, aber das machte nichts, weil ich noch kein Kind hatte. Mit der Zeit trugen andere immer mehr bei, und jetzt gibt es ein Symfony-Team von etwa 40 Leuten, die an der Dokumentation arbeiten. Am Anfang war ich ein junger, unerfahrener Entwickler, und die großartige Dokumentation von Symfony war für mich entscheidend. Ich wollte Symfony 2 für neue Entwickler zugänglich und einladend machen.

Marine: Hat es für Sie damit begonnen, etwas zurückzugeben, oder hatten Sie bereits eine Leidenschaft für das Teilen und die Bildung?

Ryan: Ich gebe gerne etwas zurück, weil es sich gut anfühlt, aber es geht auch darum, dass es Spaß macht, Code zu öffnen und zu sehen, wie die Dinge zusammenhängen. Wenn jeder alles selbst herausfinden müsste, wäre das reine Zeitverschwendung. Wenn man sein Wissen weitergibt, kann man eine Grundlage für andere schaffen.

Marine: Sie haben also auch angefangen, Code beizusteuern?

Ryan: Ja, es stört mich, wenn sich Dinge wiederholen und ineffizient sind. Ich habe um Symfony 3 herum angefangen, mehr beizutragen, indem ich das Maker-Bundle erstellt habe, um Code zu generieren und die Erfahrung der Entwickler zu verbessern. Es geht um schmerzorientierte Entwicklung - die Beseitigung von Reibungsverlusten, um eine reibungslosere Erfahrung für Entwickler zu schaffen.

Marine: Ich finde das toll, weil Sie immer noch Dokumentation machen, nur auf eine andere Art und Weise.

Ryan: Das ist ein guter Punkt.

Marine: Wenn man etwas erklären will und merkt, dass es zu komplex ist, kann man dann auch Code beisteuern?

Ryan: Ja, wenn man Dokumentation schreibt oder Screencasts erstellt und etwas als schmerzhaft empfindet, wird einem klar, dass es behoben werden muss. Die Benutzer haben Probleme, von denen die Betreuer vielleicht nicht einmal wissen. Wenn Sie diese Probleme artikulieren und lösen können, ist das sehr hilfreich. Selbst das Öffnen eines Tickets kann ein nützlicher Beitrag sein.

Marine: Ein Ticket für die Dokumentation zu öffnen funktioniert auch?

Ryan: Ja, ein Ticket mit Details und möglichen Lösungen zu öffnen ist eine gute Möglichkeit, einen Beitrag zu leisten. Es ist weniger einschüchternd, als direkt eine Anfrage zu stellen.

Marine: Interessant. Wie bist du von den Kernbeiträgen zu SymfonyCasts gekommen?

Ryan: Als Symfony 2 auf den Markt kam, haben wir persönliche Schulungen angeboten, aber die waren nicht für jeden zugänglich. Wir mussten diese Erfahrung erschwinglich für kleinere Unternehmen verpacken. SymfonyCasts wurde aus diesem Bedürfnis heraus geboren, und es ist großartig, dass es auch dazu beiträgt, die Open Source von Symfony zu finanzieren.

Marine: Ihre Frau hilft dabei?

Ryan: Ja, sie ist unsere Front-End-Entwicklerin. Ich würde am liebsten alles verschenken, aber sie sorgt dafür, dass wir auch unser Haus und unser Essen bezahlen können.

Marine: Das Gleichgewicht zwischen Geben und Verdienen ist eine große Frage im Open-Source-Bereich.

Ryan: Ja, das ist das klassische Problem. Projekte wie die PHP Foundation und die Drupal Foundation helfen, indem sie Entwickler für die Arbeit an wichtigen Initiativen bezahlen.

Marine: Unternehmen sollten auch etwas zurückgeben. Wir bei Platform.sh sponsern Symfony und andere Open-Source-Projekte. Das macht einen großen Unterschied.

Ryan: Das tut es.

Marine: Du hast dein Kind zur SymfonyCon mitgebracht. Wie wirkt sich die Geburt eines Kindes auf Ihre Open-Source-Beiträge aus?

Ryan: Es ändert alles. Bevor man Kinder hatte, konnte man Open Source in seiner Freizeit machen. Mit Kindern braucht man Geld, um es zu einem Teil des Arbeitstages zu machen. Ich mache meine Open-Source-Arbeit zwischen 9 und 5, weil SymfonyCasts das unterstützt.

Marine: Zeigen Ihre Kinder irgendein Interesse an der Entwicklung?

Ryan: Überhaupt nicht. Aber wenn ich meinen Sohn zu Konferenzen mitnehme, geht es mir darum, ihm eine weltliche Erfahrung zu ermöglichen und Menschen mit unterschiedlichem Hintergrund zu treffen.

Marine: Das ist erstaunlich. Wie sieht es mit der Mitarbeit an anderen Projekten aus?

Ryan: Ich konzentriere mich hauptsächlich auf Symfony, aber ich habe angefangen, zu einigen JavaScript-Tools beizutragen, die sowohl in Symfony als auch in Ruby on Rails verwendet werden. Es ist toll, von einer anderen Community zu lernen und diese Erkenntnisse auf Symfony anzuwenden.

Marine: Ist es möglich, zu SymfonyCasts beizutragen?

Ryan: Es ist schwierig, Screencasts zu erstellen. Wir freuen uns zwar über Beiträge, aber das ist eine spezielle Aufgabe. Wir haben Skripte und Code-Blöcke kostenlos zur Verfügung gestellt, um den Inhalt leichter zugänglich zu machen.

Marine: Wie sieht es mit der Übersetzung der Dokumentation aus?

Ryan: Die Übersetzung ist eine Herausforderung, da sich die Dokumentation häufig ändert. Die automatischen Übersetzungswerkzeuge werden jedoch immer besser. Wir übersetzen unsere Skripte und Untertitel auf SymfonyCasts ins Spanische und planen, weitere Sprachen hinzuzufügen.

Marine: Lokale Gemeinschaften erstellen auch Wissensdatenbanken in ihren Sprachen. Es geht darum, Informationen zugänglich zu machen.

Ryan: Ja, leidenschaftliche unabhängige Gemeinschaften spielen eine entscheidende Rolle.

Marine: Was haben Sie über die Vermittlung und den Austausch von Wissen gelernt?

Ryan: Es sollte eine Geschichte erzählen, etwas Reales aufbauen, das ein Problem löst. Man sollte den Leuten die Schritte zeigen, die man zur Lösung des Problems unternommen hat, und nicht nur das Endergebnis.

Marine: Wenn man die Logik versteht, kann man sie reproduzieren, nicht nur die Schritte nachvollziehen.

Ryan: Ganz genau.

Marine: Wenn Sie die Erlaubnis hätten, einen Tag lang alles zu tun, was würden Sie tun?

Ryan: Ich würde nach Cedar Point fahren, einen Vergnügungspark, und den ganzen Tag Achterbahn fahren. Mit einem 7-jährigen Kind ist das zwar nicht realistisch, aber es würde Spaß machen.

Marine: Was wäre, wenn du eine neue Erlaubnis erfinden könntest?

Ryan: Schneller-als-Licht-Reisen. Ich liebe den Weltraum und Science-Fiction. Wir müssen das Universum ohne die deprimierenden Auswirkungen der Zeitdilatation erforschen.

Marine: Was ist deine größte Fähigkeit?

Ryan: Mit Kindern unter sieben Jahren zu spielen. Ich liebe es, Ärger zu machen und Spaß mit ihnen zu haben. Das ist eine Superkraft.

Marine: Eltern, lasst eure Kinder nicht unbeaufsichtigt mit Ryan!

Ryan: Wir werden uns amüsieren, aber es wird einen Aufstand geben.

Marine: Ich danke dir, Ryan. Es war toll, dich dabei zu haben. Ich freue mich auf die Zukunft von SymfonyCasts.

Ryan: Ich mich auch. Danke, dass ich dabei sein durfte.

Ihr größtes Werk
steht vor der Tür

Kostenloser Test
Discord
© 2025 Platform.sh. All rights reserved.