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