Maybe Our Documentation "Best Practices" Aren''t Really Best Practices

Kayce Basques, ein großartiger Tech-Autor aus unserem Team, schrieb einen ziemlich erstaunlichen Artikel über seine Erfahrungen, in dem er misst, wie gut die bewährten Best Practices für die Dokumentation von technischem Material funktionieren. Bewährte Verfahren in diesem Sinne können bekannte Industriestandards für das technische Schreiben sein, oder es kann ein Leitfaden für Ihr eigenes Schreibstil sein. Hör zu!

Recently I discovered that a supposed documentation “best practice” may not actually stand up to scrutiny when measured in the wild. I’m now on a mission to get a “was this page helpful?” feedback widget on every documentation page on the web. It’s not the end-all be-all solution, but it’s a start towards a more rigorous understanding of what actually makes our docs more helpful.

Read full post .

Obwohl ich kein Tech-Autor bin, beinhaltet meine Rolle eine enorme Menge an Engagement in unserem Tech-Writing-Team sowie die Veröffentlichung zahlreicher „Best Practices“ für Entwickler. Ich war erstaunt darüber, wie viel und tiefgründig Kayce mit der Kunst des Schreibens moderner Dokumente aus dem Blickwinkel der Inhalte unseres Teams beigetragen hat. Ich empfehle Ihnen dringend, Kayces Artikel ausführlich zu lesen - ich habe viel gelernt. Danke, Kayce!

Paul Kinlan

Trying to make the web and developers better.

RSS Github Medium