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

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

私たちのチームの素晴らしい技術ライターであるKayce Basquesは、既存のドキュメンテーションのベストプラクティスが技術的な資料を説明するためにどれほどうまく機能しているかを測定した彼の経験についてかなり驚くべき記事を書きました。この意味でのベストプラクティスは、テクニカルライティングの業界標準としてよく知られている場合もあれば、スタイルガイドを書いているあなた自身の会社の場合もあります。見てみな!

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

私はテックライターではありませんが、私の役割は私たちのテックライティングチームとの大きな関わり合いと、開発者自身のためのたくさんの「ベストプラクティス」の発行も含みます。 Kayceが私たちのチームのコンテンツのレンズを通して現代の文書を書くことの芸術に関してどれだけの深さと研究をしたかに驚きました。 Kayceの記事を詳しく読むことを強くお勧めします - 私は多くのことを学びました。ケイシーありがとう!

Paul Kinlan

Trying to make the web and developers better.

RSS Github Medium