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

Paul Kinlan
Available in: English (Original) Deutsch Español 日本語 मानक हिन्दी русский язык tiếng Việt bahasa Indonesia

Kayce Basques, un formidable rédacteur technique de notre équipe, a écrit un article plutôt étonnant sur ses expériences, mesurant la mesure dans laquelle les meilleures pratiques de la documentation existante permettent d'expliquer du matériel technique. Les meilleures pratiques dans ce sens peuvent être des normes bien connues de l’industrie en matière de rédaction technique, ou bien il peut s’agir du guide de rédaction de votre propre entreprise. Vérifiez-le!

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 .

Bien que je ne sois pas un rédacteur technique, mon rôle implique une très grande implication de notre équipe de rédacteurs techniques ainsi que la publication de nombreuses «meilleures pratiques» pour les développeurs. J’ai été émerveillé par toute la profondeur et les recherches que Kayce a effectuées sur l’art d’écrire des documents modernes à travers le prisme du contenu de nos équipes. Je vous encourage fortement à lire l'article de Kayce en profondeur - j'ai beaucoup appris. Merci Kayce!

Paul Kinlan

Trying to make the web and developers better.

RSS Github Medium