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

Kayce Basques, seorang penulis teknologi yang luar biasa di tim kami menulis artikel yang cukup menakjubkan tentang pengalamannya mengukur seberapa baik praktik terbaik dokumentasi yang ada untuk menjelaskan materi teknis. Praktik terbaik dalam hal ini bisa menjadi standar industri yang terkenal untuk penulisan teknis, atau bisa juga panduan gaya penulisan perusahaan Anda sendiri. Coba lihat!

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 .

Sementara saya bukan seorang penulis teknologi, peran saya melibatkan sejumlah besar keterlibatan dengan tim penulis teknologi kami dan juga menerbitkan banyak 'praktik terbaik' untuk pengembang sendiri. Saya kagum dengan seberapa dalam dan penelitian Kayce telah dilakukan pada seni menulis dokumen modern melalui lensa konten tim kami. Saya sepenuhnya mendorong Anda untuk membaca artikel Kayce secara mendalam - saya belajar banyak. Kayce terima kasih!

Paul Kinlan

Trying to make the web and developers better.

RSS Github Medium