तकनीकी लेखक - सरल-भाषा परियोजना प्रलेखन के लिए

# FORME.md - ${name} - पूर्ण दस्तावेज़ ## 1. बड़ी तस्वीर (परियोजना अवलोकन) यह परियोजना ${name} है - [परियोजना का एक-वाक्य विवरण यहाँ डालें]। यह [लक्षित उपयोगकर्ता] के लिए [समस्या] का समाधान करती है, और इसे [मंच/चरण] के रूप में डिज़ाइन किया गया है। **यह किस समस्या का समाधान करती है और किसके लिए:** [समस्या का सरल भाषा में विवरण और यह किसके लिए है] **उपयोगकर्ता यात्रा (सरल शब्दों में):** [उपयोगकर्ता इसके साथ कैसे इंटरैक्ट करता है - पहली बार आने से लेकर नियमित उपयोग तक] **सादृश्य:** इस पूरी प्रणाली को एक [रेस्तरां/पुस्तकालय/कारखाने] की तरह समझें। [विस्तृत सादृश्य यहाँ - प्रत्येक भाग की तुलना किसी परिचित चीज़ से करें] --- ## 2. तकनीकी वास्तुकला - ब्लूप्रिंट ### सिस्टम का नक्शा ``` [उपयोगकर्ता] → [फ्रंटएंड] → [एपीआई/बैकएंड] → [डेटाबेस] ↓ ↓ [स्टाइल/UI] [बाहरी सेवाएं] ``` ### प्रत्येक परत की सैर **फ्रंटएंड (स्वागत कक्ष):** यह वह हिस्सा है जो उपयोगकर्ता देखता और छूता है। यहाँ सारी दृश्य चीज़ें होती हैं - बटन, फॉर्म, पेज। इसे ऐसे समझें जैसे रेस्तरां का स्वागत क्षेत्र - यहाँ मेहमान आते हैं, मेनू देखते हैं, और ऑर्डर देते हैं। **एपीआई/बैकएंड (रसोई):** यहाँ असली काम होता है। फ्रंटएंड से आए अनुरोध यहाँ प्रोसेस होते हैं। रेस्तरां के उदाहरण में, यह रसोई है - ऑर्डर यहाँ आते हैं, खाना यहाँ बनता है, और तैयार डिश वापस भेजी जाती है। **डेटाबेस (फाइलिंग कैबिनेट):** यह सारा डेटा संग्रहीत करता है - उपयोगकर्ता जानकारी, ऑर्डर, सेटिंग्स। यह रेस्तरां का रिकॉर्ड रूम है जहाँ हर ग्राहक का इतिहास, हर ऑर्डर का विवरण, और हर इन्वेंट्री आइटम का हिसाब रखा जाता है। ### वास्तुकला निर्णय - "यह क्यों और दूसरा क्यों नहीं?" - **[निर्णय 1]:** [स्पष्टीकरण] - हमने यह इसलिए चुना क्योंकि [कारण], भले ही [विकल्प] भी संभव था। - **[निर्णय 2]:** [स्पष्टीकरण] - इसका मतलब है कि [व्यापार-नापसंद]। - **[विशेष/चतुर विकल्प]:** [डेवलपर का कोई अनोखा निर्णय और उसका कारण] --- ## 3. कोडबेस संरचना - फाइलिंग सिस्टम ### फोल्डर ट्री (शीर्ष 2-3 स्तर) ``` ${name}/ ├── [फोल्डर 1]/ │ ├── [सबफोल्डर]/ │ └── [फाइलें] ├── [फोल्डर 2]/ │ ├── [सबफोल्डर]/ │ └── [फाइलें] ├── [फोल्डर 3]/ └── [मुख्य फाइलें] ``` ### प्रत्येक प्रमुख फोल्डर की व्याख्या **[फोल्डर 1]:** यहाँ [क्या रहता है]। आपको यह फोल्डर तब खोलना होगा जब [कब खोलें]। यह [अन्य फोल्डर] से इस तरह जुड़ा है - [संबंध]। **[फोल्डर 2]:** यहाँ [क्या रहता है]। आपको यह फोल्डर तब खोलना होगा जब [कब खोलें]। यह [अन्य फोल्डर] से इस तरह जुड़ा है - [संबंध]। **[फोल्डर 3]:** यहाँ [क्या रहता है]। आपको यह फोल्डर तब खोलना होगा जब [कब खोलें]। यह [अन्य फोल्डर] से इस तरह जुड़ा है - [संबंध]। ### नामकरण परंपराएं - [गैर-स्पष्ट नामकरण नियम 1] - [गैर-स्पष्ट नामकरण नियम 2] ### प्रवेश बिंदु सिस्टम यहाँ से शुरू होता है: [फाइल पथ]। यह वह जगह है जहाँ ऐप लोड होता है और सब कुछ शुरू होता है। --- ## 4. कनेक्शन और डेटा प्रवाह - चीज़ें कैसे बात करती हैं ### उपयोगकर्ता क्रिया 1: [क्रिया का नाम, जैसे "उपयोगकर्ता साइन अप करता है"] जब उपयोगकर्ता "[बटन/लिंक]" पर क्लिक करता है, तो पर्दे के पीछे यह होता है: 1. बटन [फाइल] में एक फंक्शन ट्रिगर करता है - इसे घंटी बजाने की तरह समझें 2. यह घंटी की आवाज़ ${api_route} तक पहुँचती है - रसोई को ऑर्डर सुनाई देता है 3. रसोई [डेटाबेस] से जाँच करती है - क्या सामग्री उपलब्ध है? 4. यदि हाँ, तो यह पुष्टि वापस भेजती है - वेटर रसीद लाता है 5. [अगले चरण...] ### उपयोगकर्ता क्रिया 2: [क्रिया का नाम, जैसे "उपयोगकर्ता ऑर्डर देता है"] [चरण-दर-चरण विवरण यहाँ] ### बाहरी सेवा कनेक्शन - **[भुगतान सेवा]:** [यह क्या करती है]। यदि यह विफल हो जाती है, तो [क्या होता है] और आपको [क्या करना चाहिए]। - **[ईमेल सेवा]:** [यह क्या करती है]। यदि यह विफल हो जाती है, तो [क्या होता है] और आपको [क्या करना चाहिए]। - **[अन्य API]:** [यह क्या करती है]। यदि यह विफल हो जाती है, तो [क्या होता है]। ### प्रमाणीकरण प्रवाह (ऐप कैसे जानता है कि आप कौन हैं?) [सरल भाषा में प्रमाणीकरण प्रक्रिया का विवरण - लॉगिन से लेकर सत्र प्रबंधन तक] --- ## 5. तकनीकी विकल्प - टूलबॉक्स | तकनीक | यहाँ इसका काम | यही क्यों चुना गया | ध्यान देने वाली बातें | |-----------|------------------|-------------|---------------| | [तकनीक 1] | [एक वाक्य में] | [विशिष्ट कारण] | [सीमाएं/व्यापार-नापसंद] | | [तकनीक 2] | [एक वाक्य में] | [विशिष्ट कारण] | [सीमाएं/व्यापार-नापसंद] | | [तकनीक 3] | [एक वाक्य में] | [विशिष्ट कारण] | [सीमाएं/व्यापार-नापसंद] | **लागत निहितार्थ:** [मुफ्त टियर, भुगतान योजनाएं, उपयोग-आधारित लागत - स्पष्ट रूप से बताएं] --- ## 6. वातावरण और कॉन्फ़िगरेशन ### पर्यावरण चर (Environment Variables) | चर | यह क्या नियंत्रित करता है (सरल भाषा में) | |-----|-------------------------------------------| | [VAR_NAME] | [स्पष्टीकरण] | | [VAR_NAME] | [स्पष्टीकरण] | | [VAR_NAME] | [स्पष्टीकरण] | ### वातावरण कैसे काम करते हैं - **विकास (Development):** [यहाँ क्या होता है] - यह आपका स्थानीय परीक्षण क्षेत्र है - **स्टेजिंग (Staging):** [यहाँ क्या होता है] - यह प्रोडक्शन का पूर्वाभ्यास है - **प्रोडक्शन (Production):** [यहाँ क्या होता है] - यह वास्तविक उपयोगकर्ताओं के लिए लाइव है ### बदलाव करने के लिए यदि आपको [X] बदलना है, तो आपको [Y] अपडेट करना होगा - लेकिन सावधान रहें क्योंकि [Z] भी प्रभावित होगा। ### गोपनीय कुंजियाँ (Secrets) [कौन सी कुंजियाँ किस सेवा से जुड़ी हैं - वास्तविक मान नहीं, केवल विवरण] --- ## 7. सीखे गए सबक - युद्ध कथाएं ### बग्स और समाधान **बग 1: [संक्षिप्त विवरण]** - **कारण:** [सरल भाषा में] - **समाधान:** [कैसे ठीक किया गया] - **भविष्य के लिए:** [इससे बचने का तरीका] **बग 2: [संक्षिप्त विवरण]** - **कारण:** [सरल भाषा में] - **समाधान:** [कैसे ठीक किया गया] - **भविष्य के लिए:** [इससे बचने का तरीका] ### खतरे और बारूदी सुरंगें - **दिखने में सरल, असल में जटिल:** [विवरण] - यह सरल लगता है लेकिन [जटिलता]। - **छिपा हुआ संबंध:** यदि आपको [X] बदलना है, तो सावधान रहें क्योंकि यह [Y] और [Z] को भी प्रभावित करता है। - **तकनीकी ऋण:** [क्या ऋण है और यह क्यों मौजूद है] - हम जानते हैं कि यह आदर्श नहीं है, लेकिन [कारण] के कारण इसे अभी ऐसे ही रखा गया है। ### खोजें - **नई तकनीकें:** [क्या खोजा गया] - **क्या काम किया:** [सफल प्रयोग] - **क्या काम नहीं किया:** [असफल प्रयोग] - **यदि मैं शुरू से शुरू करता:** [सीखे गए सबक के आधार पर सलाह] ### इंजीनियरिंग ज्ञान - **सर्वोत्तम अभ्यास:** [इस परियोजना से उभरे पैटर्न] - **विश्वसनीय पैटर्न:** [जो बार-बार काम करे] - **अनुभवी इंजीनियर कैसे सोचते हैं:** [समस्या-समाधान दृष्टिकोण] --- ## 8. त्वरित संदर्भ कार्ड ### स्थानीय रूप से प्रोजेक्ट कैसे चलाएं (शून्य सेटअप मानकर) 1. [चरण 1 - जैसे: Node.js इंस्टॉल करें] 2. [चरण 2 - जैसे: रिपॉजिटरी क्लोन करें] 3. [चरण 3 - जैसे: निर्भरताएं इंस्टॉल करें] 4. [चरण 4 - जैसे: पर्यावरण चर सेट करें] 5. [चरण 5 - जैसे: डेवलपमेंट सर्वर चलाएं] ### मुख्य URL - **प्रोडक्शन:** [URL] - **स्टेजिंग:** [URL] - **एडमिन पैनल:** [URL] - **डैशर्ड:** [URL] ### समस्या होने पर कहाँ जाएं - **तकनीकी समस्याएं:** [संपर्क/चैनल] - **डेटा समस्याएं:** [संपर्क/चैनल] - **सुरक्षा चिंताएं:** [संपर्क/चैनल] ### सबसे आम कमांड | कमांड | यह क्या करता है | |--------|-----------------| | [कमांड 1] | [विवरण] | | [कमांड 2] | [विवरण] | | [कमांड 3] | [विवरण] | --- *यह दस्तावेज़ ${name} परियोजना की एक जीवित व्याख्या है। जैसे-जैसे परियोजना विकसित होती है, इसे अपडेट करते रहें।*