एक तकनीकी विनिर्देश एक दस्तावेज है जो बताता है कि कोई उत्पाद या परियोजना क्या करती है और यह दर्शाती है कि उद्देश्यों को कैसे प्राप्त किया जाए। आपको ग्राहकों और टीम को उन समस्याओं से परिचित कराना होगा जिन्हें आप हल करना चाहते हैं, उत्पाद या परियोजना के उद्देश्य और आवश्यकताएं। दस्तावेज़ उस कार्य का वर्णन करता है जिसे किया जाना है और यह स्वाभाविक है कि इसे परियोजना के निष्पादन के दौरान फिर से लिखा जाएगा।
कदम
3 का भाग 1: शीर्षक लिखना
चरण १। पहली पंक्ति पर और १४ या १६ आकार के बिना सेरिफ़ फ़ॉन्ट में प्रोजेक्ट का नाम लिखें।
फ़ॉन्ट का आकार बड़ा होना चाहिए ताकि इसे पढ़ना आसान हो और बाकी टेक्स्ट से अलग दिखे। शीर्षक को सही ठहराएं या इसे केंद्र में रखें।
कंपनी या उसके वरिष्ठ को एक टेम्पलेट प्रदान करना चाहिए जो दिखाता है कि शीर्षक कैसे लिखना है। जब कोई टेम्प्लेट हो, तो बस उसका पालन करें।
क्या तुम्हें पता था?
सैन्स सेरिफ़ फ़ॉन्ट्स में अक्षर के तनों के सिरों पर डैश और एक्सटेंशन नहीं होते हैं, जिससे वे अधिक आधुनिक दिखते हैं। सबसे आम उदाहरण एरियल, कैलीब्री और वर्दाना हैं।
चरण २। परियोजना के नाम के नीचे की तारीख को आकार १२ के बिना सेरिफ़ फ़ॉन्ट के साथ लिखें।
एक पंक्ति छोड़ें और फ़ॉन्ट का आकार घटाकर 12 कर दें, लेकिन फ़ॉन्ट को बदले बिना। पारंपरिक तरीके से तिथि दर्ज करें: वर्ष z के महीने y का दिन x।
- यदि कोई टेम्प्लेट है, तो तारीख को सही प्रारूप में प्राप्त करने के लिए इसे पढ़ें।
- तिथि बहुत महत्वपूर्ण है क्योंकि यह आपको यह बताती है कि दस्तावेज़ का नवीनतम संस्करण क्या है।
चरण 3. तिथि के तहत "लेखक" और लेखक का नाम टाइप करें।
एक और लाइन छोड़ें और "Author" लिखें और उसके बाद एक कोलन लिखें। अपना नाम दर्ज करें क्योंकि आप दस्तावेज़ का निर्माण कर रहे हैं। इसमें बस अपना नाम लिख दें, भले ही काम ग्रुप डिस्कशन का नतीजा ही क्यों न हो।
एक तकनीकी विनिर्देश में हमेशा एक ही लेखक होना चाहिए, भले ही वह एक टीम प्रयास हो। लेखक वह व्यक्ति है जो दस्तावेज़ लिखता है।
चरण 4. "टीम" और परियोजना के सदस्यों के नाम दर्ज करें।
अगली पंक्ति में, "टीम" और एक कोलन लिखें। उन सभी लोगों की सूची बनाएं जो प्रोजेक्ट या उत्पाद पर काम कर रहे हैं।
- टीम के सदस्यों को श्रेय देने के अलावा, यह लोगों को यह बताने का एक तरीका है कि तकनीकी विनिर्देश के बारे में प्रश्न होने पर उन्हें किसके पास जाना चाहिए।
- यदि आपने अकेले प्रोजेक्ट पर काम किया है, तो इस चरण को छोड़ दें।
3 का भाग 2: तकनीकी विशिष्टता को स्केच करना
चरण 1. परियोजना या उत्पाद का संक्षिप्त सारांश लिखें।
आप जो कर रहे हैं उसके सारांश के साथ दस्तावेज़ प्रारंभ करें। अनुभाग शीर्षक के रूप में "सारांश" दर्ज करें। समस्या का वर्णन करें, उत्पाद या परियोजना और उसके कार्य का एक मूल विचार दें। फिर बताएं कि आप अंतिम लक्ष्य तक कैसे पहुंचना चाहते हैं और कुछ विवरण दिखाएं। प्रासंगिक विपणन या इंजीनियरिंग दस्तावेजों का उल्लेख करें और अंत में, उत्पाद या परियोजना को पूरा करने के लिए आवश्यक समय का अनुमान लगाएं।
कुछ इस तरह लिखें: “वर्तमान यात्रा प्रणाली यात्रियों की दो लाइनों पर एकाग्रता और तीसरे के कम उपयोग का कारण बनती है। इंटरनेट पर केवल दो बस लाइनों की यात्रा की योजना बनाना संभव है, लेकिन दूसरी अभी भी कागज के नक्शे और टेलीफोन के साथ काम करती है। यह मॉडल यात्रियों की संख्या में कमी और कंपनी के राजस्व में कमी का कारण बन रहा है, जैसा कि सितंबर 2019 की रिपोर्ट में दिखाया गया है। हम मौजूदा सिस्टम को केवल एक में मर्ज करने का प्रस्ताव करते हैं जो तीन बस लाइनों तक इंटरनेट एक्सेस की अनुमति देता है। इस तरह, यात्रियों के पास यात्रा करने का एक आसान और तेज़ तरीका होगा और यह पता चल जाएगा कि बस स्टॉप पर कब पहुंचेगी। इसके अलावा, वे सीधे संपर्क समारोह के साथ समस्याओं की रिपोर्ट करने में सक्षम होंगे।”
चरण 2. उद्देश्यों का एक खंड बनाएं यदि वे सारांश में शामिल नहीं हैं।
शीर्षक के रूप में "लक्ष्य" टाइप करें और संक्षेप में बताएं कि आप परियोजना या उत्पाद के साथ क्या हासिल करना चाहते हैं। अनुभाग को शुरू करके पाठ की शुरुआत करें और एक आइटम या क्रमांकित सूची में उद्देश्यों का उल्लेख करें।
- यदि आपने उद्देश्यों को सारांश में प्रस्तुत किया है, तो इस खंड को करना आवश्यक नहीं है, जब तक कि कंपनी को इसकी आवश्यकता न हो।
- कुछ इस तरह लिखें: "नई प्रणाली में शामिल हैं: 1) एक मार्ग नियोजन उपकरण; 2) बस की भौगोलिक स्थिति का कार्य; 3) यात्रियों के लिए समस्याओं को संप्रेषित करने का एक तरीका।
चरण 3. उत्पाद की आवश्यकताओं को एक अलग हिस्से में लिखें।
शीर्षक के रूप में "उत्पाद आवश्यकताएँ" टाइप करें और वर्णन करें कि समस्या को हल करने के लिए क्या आवश्यक है। विषयों की सूची का उपयोग करें और अनुभाग को शुरू करने के बारे में चिंता न करें।
उदाहरण के लिए: “१) रूट प्लानर यह सुनिश्चित करता है कि यात्रियों को केवल कुछ लाइनों पर केंद्रित नहीं किया जाएगा; 2) संपर्क बॉक्स एक ऐसा साधन है जो यात्रियों की शंकाओं के समाधान की सुविधा प्रदान करता है।
चरण 4. समझाएं कि परियोजना के दायरे से बाहर क्या है।
"कार्यक्षेत्र से बाहर" अनुभाग का शीर्षक दें। परिचयात्मक पैराग्राफ न लिखें, बल्कि केवल उन चीजों की एक सूची बनाएं जो समस्या को हल करने के लिए नहीं की जाएंगी, उदाहरण के लिए, क्या काम नहीं किया जाएगा, समाधान जिन्हें आप अपर्याप्त मानते हैं, और ऐसी विशेषताएं जो उत्पाद या परियोजना में नहीं हैं। बहुत विशिष्ट बनें ताकि उपभोक्ताओं और कर्मचारियों को संदेश सही मिले।
कुछ इस तरह लिखें: “१) नई प्रणाली से बस लाइनों का मार्ग नहीं बदलेगा; 2) हम बस स्टॉप पर कंप्यूटर या स्क्रीन नहीं लगाएंगे, इसलिए यात्रियों को अपने मोबाइल उपकरणों का उपयोग करना चाहिए; 3) हम केवल व्यवस्था में बदलाव के साथ ही समस्या के तत्काल समाधान की गारंटी नहीं देते हैं; 4) यात्रियों को घर के दरवाजे पर नहीं उठाया जाएगा।
विकल्प:
खंड को तकनीकी विनिर्देश के अंत में और समयरेखा से पहले रखा जाना आम बात है। इसे उस क्रम में रखें जैसा आप चाहते हैं या जो स्पष्ट रूप से निर्देश दिया गया है।
चरण 5. अनसुलझे मुद्दों पर चर्चा करने के लिए "खुले प्रश्न" अनुभाग शामिल करें।
तकनीकी विनिर्देश उपभोक्ताओं को बेहतर ढंग से सूचित करने और समान लक्ष्यों की ओर टीम का मार्गदर्शन करने के लिए उत्पाद या डिज़ाइन का एक सिंहावलोकन प्रस्तुत करता है। हर विवरण के माध्यम से जाने या हर समस्या को हल करने के बारे में चिंता न करें, लेकिन बाद में हल किए जाने वाले बिंदुओं को सूचीबद्ध करने के लिए "ओपन इश्यूज" नामक एक अनुभाग बनाएं।
उदाहरण के लिए लिखें: “१) हम अपग्रेड सिस्टम को कैसे संभालेंगे? २) समस्या होने पर क्या हम मार्ग बदल देंगे? 3) क्या सिस्टम अन्य भाषाओं में सूचना दिखाएगा? 4) हम उन यात्रियों की सेवा कैसे करेंगे जो नई तकनीकों में महारत हासिल नहीं करते हैं?”
चरण 6. योजना को दृष्टिकोण अनुभाग में प्रस्तुत करें।
इसे "योजना" या "दृष्टिकोण" शीर्षक दें। दिखाएं कि आप समस्याओं को कैसे हल करना चाहते हैं या विभिन्न दृष्टिकोणों पर विचार किया जा रहा है यदि परियोजना प्रारंभिक चरण में है। अनुसंधान और उपयोग की जाने वाली तकनीकों और प्रक्रियाओं के प्रकारों का वर्णन करें। यदि संभव हो, तो पाठकों के लिए समझने में आसान बनाने के लिए चित्र, ग्राफ़ और आरेख सम्मिलित करें। अंत में, चर्चा करें कि आप परीक्षण कैसे चलाएंगे और समस्याएं होने पर आप क्या कार्रवाई करेंगे।
- यदि आपको विभिन्न दृष्टिकोणों और तकनीकों का वर्णन करना है, तो प्रत्येक के लिए एक उपखंड बनाएं।
- कुछ इस तरह लिखें: “हम एक ऐप बनाने के लिए यात्रा योजना टीम के साथ काम करेंगे जो यात्रियों को उनके वांछित गंतव्य में प्रवेश करने और स्वचालित रूप से मार्ग उत्पन्न करने की अनुमति देता है। उपयोगकर्ता मार्ग बदल सकते हैं। यात्रियों को मार्ग खोजने में मदद करने के लिए सिस्टम टेक्स्ट अपडेट भेजता है। हम कुछ ग्राहकों को परीक्षण सत्र में शामिल करेंगे जो लॉन्च से पहले आयोजित किया जाएगा। जब समस्या होगी, हम सुबह में रखरखाव करेंगे, जब बसें नहीं चल रही होंगी। इसके अलावा, हमारे पास उन यात्रियों को लेने के लिए एक अतिरिक्त वाहन होगा जो एक बस के भरे होने के कारण उस पर चढ़ने में असमर्थ थे।”
विकल्प:
योजना को सारांशित करने के लिए "तैयारी" नामक एक अनुभाग शामिल करें। यह आमतौर पर वैकल्पिक है।
चरण 7. उन विकल्पों के बारे में बात करें जिन पर विचार किया गया था लेकिन अंततः त्याग दिया गया था।
इस सामग्री को योजना के सबस्टेप के रूप में या दस्तावेज़ के अंत में और समय से पहले रखें। "विचार किए गए विकल्प" शीर्षक के तहत लिखें और उनका वर्णन करें। समझाएं कि आपने प्रत्येक विकल्प को क्यों छोड़ दिया।
इसे इस तरह लिखें: "हमने किंवदंतियों के साथ रंगीन मानचित्रों का उपयोग करने की संभावना को सस्ता माना, लेकिन यात्रियों के बीच अच्छी स्वीकृति नहीं थी और परीक्षण समूह भ्रमित था।"
चरण 8. उत्पाद या परियोजना मूल्यांकन विधियों और मापों का वर्णन करें।
सामग्री को एक या अधिक अनुभागों में रखें। इसे "मापने का प्रभाव", "आकलन" या "माप" लेबल करें। एक या दो पैराग्राफ में बताएं कि आप कैसे सुनिश्चित करेंगे कि यह सही तरीके से काम करता है और लक्ष्यों को प्राप्त करता है। साथ ही, यह भी बताएं कि त्रुटियों और समस्याओं की जांच कैसे करें।
- विश्लेषण प्रक्रियाओं और प्रौद्योगिकियों के बारे में बात करें जिनका उपयोग किया जाएगा।
- ऐसा कुछ कहें: “हम यह सुनिश्चित करने के लिए मार्ग के अनुमानित समय और वास्तविक आवागमन के बीच तुलना करेंगे कि आप शेड्यूल पर बने रहें। इसके अलावा, हम संतुष्टि की डिग्री का आकलन करने और समस्याओं की पहचान करने के लिए यात्रियों के साथ एक सर्वेक्षण करेंगे।"
चरण 9. दिखाएं कि आप सुरक्षा और गोपनीयता कैसे बनाए रखेंगे।
"सुरक्षा और गोपनीयता" शीर्षक लिखें और समझाएं कि आप उपयोगकर्ताओं को डिजिटल हमलों से कैसे बचाएंगे। कुछ पैराग्राफ में जोखिम और गोपनीयता सुरक्षा तंत्र का वर्णन करें।
- हमेशा जोखिम और समस्याएं होती हैं, इसलिए यह कभी न कहें कि वे मौजूद नहीं हैं।
- इसे इस तरह लिखें: “उपयोगकर्ता वर्तमान स्थान और घर का पता प्रदान करते हैं। वे एक प्रोफ़ाइल बना सकते हैं और अपने यात्रा इतिहास को सहेज सकते हैं। हम डेटा की सुरक्षा के लिए एन्क्रिप्शन विधियों और फ़ायरवॉल का उपयोग करेंगे।"
चरण 10. दस्तावेज़ को एक समयरेखा और टाइमस्टैम्प की सूची के साथ समाप्त करें।
प्रोजेक्ट को ट्रैक पर रखने और आपको वास्तव में क्या और कब करने की आवश्यकता है, यह दिखाने के लिए समयरेखा एक महत्वपूर्ण उपकरण है। इसे "टाइमलाइन" शीर्षक दें और कार्यों को विभाजित करें। प्रत्येक टीम या सदस्य के लिए विषयों की सूची बनाएं।
- उदाहरण के लिए, कार्यों के विभाजन में "इंजीनियरिंग टीम", "योजना टीम", "विपणन" और "गुणवत्ता आश्वासन" शामिल हो सकते हैं।
- इंजीनियरिंग टीम की टू-डू सूची में इस तरह के आइटम हो सकते हैं: "1) साइट के लिए एक अपडेट विकसित करें; 2) एक यात्रा योजना ऐप लिखें; 3) एक संपर्क प्रणाली प्रोग्राम करें।"
भाग ३ का ३: तकनीकी विनिर्देश को अंतिम रूप देना
चरण 1. दस्तावेज़ में एकल स्थान का उपयोग करें और अनुभागों के बीच एक पंक्ति छोड़ें।
सिंगल स्पेस तकनीकी विनिर्देश के आकार को कम करता है और दस्तावेज़ को हेरफेर करना आसान बनाता है। पैराग्राफ या अनुभाग बदलते समय, केवल एक पंक्ति को छोड़ दें ताकि अनावश्यक स्थान न जोड़ें।
यह संभव है कि संगठन स्वरूपण पर विशिष्ट निर्देश देगा। अगर ऐसा है तो उनका पालन करें।
चरण 2. दस्तावेज़ में दूसरे व्यक्ति बहुवचन सर्वनाम का प्रयोग करें।
जब आप उस कार्य की चर्चा कर रहे हों जो आपके और आपकी टीम द्वारा किया जाएगा, हमेशा "हम" का प्रयोग करें। किसी विशिष्ट टीम या व्यक्ति का उल्लेख करते समय, पूरा नाम शामिल करें ताकि संदर्भ स्पष्ट हो। इस तरह आप तकनीकी विनिर्देश को अधिक उद्देश्यपूर्ण बनाते हैं।
- उदाहरण के लिए, "विनिर्देशों को आवश्यकतानुसार अपडेट किया जाएगा" की तुलना में "हम आवश्यकतानुसार विनिर्देशों को अपडेट करेंगे" लिखना बेहतर है।
- इसी तरह, "इंजीनियरिंग टीम साइट का निर्माण करेगी" या "मार्टा डी सूसा मार्केटिंग योजना को परिभाषित करने के लिए जिम्मेदार होगी" कहें।
चरण 3. स्पष्ट, संक्षिप्त और समझने में आसान भाषा का प्रयोग करें।
इस प्रकार के दस्तावेज़ों में वाक्यों और विचारों को पॉलिश न करें क्योंकि यह केवल आपका और पाठक का समय बर्बाद करता है। विचारों को उपदेशात्मक तरीके से व्यक्त करने के लिए यथासंभव कम शब्दों का प्रयोग करें। रिपोर्ट की समीक्षा करें और सभी अनावश्यक शब्दों और दोहराव वाले वाक्यांशों को हटा दें।
उदाहरण के लिए, "हम एक वेबसाइट बनाएंगे जो यात्रियों को यात्रा की योजना बनाने और बस पथ की निगरानी करने की अनुमति देती है" को "वेबसाइट यात्रा की योजना बनाने और बस पथ की निगरानी करने की अनुमति देगी"।
चरण 4. किसी सहकर्मी से दस्तावेज़ की समीक्षा करने और सुझाव या आलोचना करने के लिए कहें।
टीम के सदस्यों के साथ तकनीकी विनिर्देश साझा करें। उन्हें त्रुटियों को चिह्नित करने और सुधार का सुझाव देने के लिए कहें।
दस्तावेज़ को फ़ील्ड के बाहर किसी को न दिखाएं, क्योंकि वह व्यक्ति उन चीज़ों को नहीं समझ सकता है जो विशेषज्ञों के लिए सरल हैं और अनावश्यक परिवर्तनों की अनुशंसा करते हैं।
चरण 5. यदि आपको इसे संशोधित करने की आवश्यकता है तो दस्तावेज़ की समीक्षा करें।
तकनीकी विनिर्देश को फिर से पढ़ते समय सुझावों और आलोचनाओं को ध्यान में रखें। सबसे महत्वपूर्ण बात यह है कि ग्राहकों और टीम के सदस्यों के लिए इसे समझना आसान है। हालांकि, कुछ सही बनाने के बारे में चिंतित न हों।
यह संभावना है कि आपको पूरे प्रोजेक्ट या उत्पाद विकास के दौरान तकनीकी विनिर्देश को अपडेट करना होगा। यह एक अस्थायी दस्तावेज़ है, इसलिए इसमें जो कहा गया है उस पर मत अटकिए।
चरण 6. दस्तावेज़ वितरित करने से पहले एक अच्छी समीक्षा करें।
इसे कम से कम दो बार और हो सके तो जोर से पढ़ें। टाइपो और शब्द अर्थ पर अधिक ध्यान दें।