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

Кейси Баскес, замечательный технический писатель из нашей команды, написал довольно удивительную статью о своем опыте измерения того, насколько хорошо существующие рекомендации по работе с документацией работают для объяснения технического материала. Лучшие практики в этом смысле могут быть общеизвестными отраслевыми стандартами технического письма или руководством по стилю написания ваших собственных компаний. Проверьте это!

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 .

Несмотря на то, что я не технический писатель, моя роль включает в себя огромное взаимодействие с нашей командой технических писателей, а также публикацию большого количества «лучших практик» для самих разработчиков. Я был поражен тем, как много Кейси провела исследование искусства написания современных документов через призму содержания наших команд. Я полностью призываю вас прочитать статью Кейси всесторонне - я многому научился. Спасибо, Кейси!

About Me: Paul Kinlan

I lead the Chrome Developer Relations team at Google.

We want people to have the best experience possible on the web without having to install a native app or produce content in a walled garden.

Our team tries to make it easier for developers to build on the web by supporting every Chrome release, creating great content to support developers on web.dev, contributing to MDN, helping to improve browser compatibility, and some of the best developer tools like Lighthouse, Workbox, Squoosh to name just a few.