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!

Paul Kinlan

Trying to make the web and developers better.

RSS Github Medium