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

Kayce Basques, một nhà văn công nghệ tuyệt vời trong nhóm của chúng tôi đã viết một bài báo khá tuyệt vời về kinh nghiệm của anh ta đo lường cách thức tài liệu tốt nhất hiện hành hoạt động tốt để giải thích tài liệu kỹ thuật. Thực tiễn tốt nhất theo nghĩa này có thể là các tiêu chuẩn công nghiệp nổi tiếng về văn bản kỹ thuật, hoặc nó có thể là hướng dẫn phong cách viết của công ty bạn. Kiểm tra nó ra!

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 .

Mặc dù tôi không phải là một nhà văn công nghệ, vai trò của tôi liên quan đến một lượng lớn sự tham gia với nhóm viết công nghệ của chúng tôi cũng như xuất bản rất nhiều 'thực tiễn tốt nhất' cho chính các nhà phát triển. Tôi đã rất ngạc nhiên bởi bao nhiêu chiều sâu và nghiên cứu mà Kayce đã thực hiện về nghệ thuật viết các tài liệu hiện đại thông qua lăng kính của nội dung nhóm chúng tôi. Tôi hoàn toàn khuyến khích bạn đọc sâu bài viết của Kayce - tôi đã học được rất nhiều. Cảm ơn bạn Kayce!

Paul Kinlan

Trying to make the web and developers better.

RSS Github Medium