मुख्य कंटेंट तक स्किप करें

तकनीकी लेखन पोर्टफोलियो

यह पूरी तरह से मेरे तकनीकी लेखन पोर्टफोलियो के सॉफ्टवेयर-संबंधी नमूनों को समर्पित एक पोर्टफोलियो है। यह सॉफ्टवेयर दस्तावेज़ीकरण के नमूनों पर एक व्यापक नज़र डालता है, जो सभी Docusaurus का उपयोग करके पूरी तरह से Markdown में लिखे और प्रकाशित किए गए हैं। यहाँ आपको डेवलपर गाइड, API संदर्भ के उदाहरण और उन्हें बनाने के लिए उपयोग किए जाने वाले वर्कफ़्लो की जानकारी मिलेगी।

पोर्टफोलियो नेविगेशन​

डिलीवरेबल प्रकार और डोमेन द्वारा आयोजित दस्तावेज़ीकरण नमूनों का अन्वेषण करें:

डेवलपर और सिस्टम गाइड​

एपीआई संदर्भ​

वास्तुकला और वैचारिक दस्तावेज़ीकरण​

कमिट संदेश और पुल अनुरोध​

केस स्टडीज​

  • Ask Artie AI असिस्टेंट केस स्टडी। प्रॉम्प्ट इंजीनियरिंग, OWASP LLM सुरक्षा और RAG पुनर्प्राप्ति वास्तुकला का विश्लेषण करने वाला एक इंजीनियरिंग केस स्टडी।

इन दस्तावेज़ों के मूल Markdown स्रोतों का निरीक्षण करने के लिए, GitHub रिपॉजिटरी पर जाएं।

डॉक्स-एज़-कोड वर्कफ़्लो​

  • VS Code और Antigravity का उपयोग करके Markdown और MDX में लेखन
  • Vale के साथ गद्य और शैली गाइड लिंटिंग
  • DeepL और Lara के साथ अंतर्राष्ट्रीयकरण और अनुवाद
  • Mermaid के साथ सिस्टम आर्किटेक्चर आरेखों का निर्माण
  • Git और GitHub के साथ संस्करण नियंत्रण और सहयोगी कोड समीक्षा
  • Postman और Swagger/OpenAPI के साथ API अन्वेषण और सत्यापन
  • Docusaurus के साथ निरंतर परिनियोजन

तकनीकी स्टैक​

  • Docusaurus। स्थिर साइटें, नेविगेशन साइडबार और स्थानीयकृत संस्करण उत्पन्न करता है।
  • VS Code। Markdown और MDX लेखन के लिए प्राथमिक संपादक के रूप में कार्य करता है।
  • Postman। API समापन बिंदुओं को मान्य करता है और अनुरोध/प्रतिक्रिया उदाहरण उत्पन्न करता है।
  • Vale। Google डेवलपर दस्तावेज़ीकरण दिशानिर्देशों को लागू करने के लिए तकनीकी गद्य की समीक्षा करता है।
  • Git और GitHub। शाखा संस्करण नियंत्रण और साइट परिनियोजन का प्रबंधन करता है।
  • Mermaid। फ्लोचार्ट और डेटा पाइपलाइन आर्किटेक्चर आरेखों को प्रस्तुत करता है।
  • DeepL और Lara। कई भाषाओं में दस्तावेज़ीकरण अनुवाद को स्वचालित करते हैं।

यह वातावरण आधुनिक इंजीनियरिंग कंपनियों में उत्पादन डेवलपर पोर्टलों को सटीक रूप से दर्शाता है।

प्रत्येक नमूना एंड-टू-एंड दस्तावेज़ निर्माण को दर्शाता है: अनुसंधान, प्रारूपण, परीक्षण, समीक्षा और प्रकाशन।