सेवा के बारे में
अनुवादितमैं तकनीकी दस्तावेज़ीकरण और उत्पाद सहायता लिखता हूँ जिसे लोग वास्तव में पढ़ते हैं: एक उपयोगकर्ता मार्गदर्शिका, एक सहायता केंद्र, एक API संदर्भ। काम उत्पाद को अलग करने से शुरू होता है। मैं इसे नए व्यक्ति की तरह देखता हूँ, हर जगह जहाँ मैं अटका, उसे लिखता हूँ, और उन वास्तविक कार्यों को इकट्ठा करता हूँ जिनके साथ आपके उपयोगकर्ता आते हैं। संरचना उन कार्यों से विकसित होती है, आपके मेनू पेड़ से नहीं: पहले लॉन्च और पहला छोटा जीत, फिर रोज़मर्रा का काम, और उसके बाद ही जटिल परिदृश्य जो कुछ ही लोगों को चाहिए लेकिन जो अधिकांश समर्थन टीम का समय ले लेते हैं।
हर लेख एक सेट के चरणों के साथ स्क्रीनशॉट है, कैप्शन के साथ ताकि पाठक कभी यह अनुमान न लगाए कि कौन सा बटन मतलब है। एक अलग अनुभाग सामान्य त्रुटियों और उनके बारे में क्या करना है, को कवर करता है: स्क्रीन पर पाठ, इसके पीछे का कारण, बाहर निकलने का तरीका। API भाग हर विधि के लिए अनुरोध और प्रतिक्रिया उदाहरण ले जाता है, फ़ील्ड और स्थिति कोड को समझाता है, और स्पष्ट रूप से बताता है कि विफलता पर क्या वापस आता है। एक शब्दकोश उत्पाद शर्तों को एक स्थान पर रखता है, ताकि इंटरफ़ेस, सहायता और समर्थन उत्तर एक ही शब्दों का उपयोग करें, और एक संक्षिप्त शैली गाइड स्वर और शब्दों को ठीक करता है, ताकि पाठ एक ही आवाज में रहे, भले ही अन्य लोग बाद में इसमें जोड़ें।
हर निर्देश को लाइव उत्पाद पर चरणों के माध्यम से चलकर सत्यापित किया जाता है; डेवलपर की याददाश्त से लिखी गई कोई भी चीज़, उस वॉकथ्रू के बिना, सहायता में नहीं जाती। उदाहरणों में कुंजी, टोकन और परीक्षण क्रेडेंशियल को प्लेसहोल्डर्स से बदल दिया जाता है। एक अधूरे फीचर के लिए दस्तावेज़ को ड्राफ्ट के रूप में चिह्नित किया जाता है और कभी भी तैयार के रूप में नहीं पेश किया जाता।
— उत्पाद वॉकथ्रू और वास्तविक उपयोगकर्ता कार्यों की सूची
— पहले लॉन्च से लेकर उन्नत परिदृश्यों तक सहायता संरचना
— स्क्रीनशॉट और कैप्शन के साथ चरण-दर-चरण निर्देश
— सामान्य त्रुटियों और उनके बारे में क्या करना है का एक अनुभाग
— अनुरोध और प्रतिक्रिया उदाहरणों के साथ API संदर्भ
— शर्तों का शब्दकोश और एक संक्षिप्त शैली और स्वर गाइड
— हर निर्देश को लाइव उत्पाद पर फिर से जांचा गया
— स्रोत एक ऐसे प्रारूप में सौंपे गए जो आगे संपादित करना आसान हो
हर लेख एक सेट के चरणों के साथ स्क्रीनशॉट है, कैप्शन के साथ ताकि पाठक कभी यह अनुमान न लगाए कि कौन सा बटन मतलब है। एक अलग अनुभाग सामान्य त्रुटियों और उनके बारे में क्या करना है, को कवर करता है: स्क्रीन पर पाठ, इसके पीछे का कारण, बाहर निकलने का तरीका। API भाग हर विधि के लिए अनुरोध और प्रतिक्रिया उदाहरण ले जाता है, फ़ील्ड और स्थिति कोड को समझाता है, और स्पष्ट रूप से बताता है कि विफलता पर क्या वापस आता है। एक शब्दकोश उत्पाद शर्तों को एक स्थान पर रखता है, ताकि इंटरफ़ेस, सहायता और समर्थन उत्तर एक ही शब्दों का उपयोग करें, और एक संक्षिप्त शैली गाइड स्वर और शब्दों को ठीक करता है, ताकि पाठ एक ही आवाज में रहे, भले ही अन्य लोग बाद में इसमें जोड़ें।
हर निर्देश को लाइव उत्पाद पर चरणों के माध्यम से चलकर सत्यापित किया जाता है; डेवलपर की याददाश्त से लिखी गई कोई भी चीज़, उस वॉकथ्रू के बिना, सहायता में नहीं जाती। उदाहरणों में कुंजी, टोकन और परीक्षण क्रेडेंशियल को प्लेसहोल्डर्स से बदल दिया जाता है। एक अधूरे फीचर के लिए दस्तावेज़ को ड्राफ्ट के रूप में चिह्नित किया जाता है और कभी भी तैयार के रूप में नहीं पेश किया जाता।
— उत्पाद वॉकथ्रू और वास्तविक उपयोगकर्ता कार्यों की सूची
— पहले लॉन्च से लेकर उन्नत परिदृश्यों तक सहायता संरचना
— स्क्रीनशॉट और कैप्शन के साथ चरण-दर-चरण निर्देश
— सामान्य त्रुटियों और उनके बारे में क्या करना है का एक अनुभाग
— अनुरोध और प्रतिक्रिया उदाहरणों के साथ API संदर्भ
— शर्तों का शब्दकोश और एक संक्षिप्त शैली और स्वर गाइड
— हर निर्देश को लाइव उत्पाद पर फिर से जांचा गया
— स्रोत एक ऐसे प्रारूप में सौंपे गए जो आगे संपादित करना आसान हो
