तकनीकी लेखन पोर्टफोलियो
यह पोर्टफोलियो पूरी तरह से मेरे तकनीकी लेखन पोर्टफोलियो के सॉफ्टवेयर-संबंधित नमूनों के लिए समर्पित है। यह सॉफ्टवेयर प्रलेखन नमूनों का एक व्यापक अवलोकन प्रदान करता है, जो सभी Docusaurus का उपयोग करके पूरी तरह से Markdown में लिखे और प्रकाशित किए गए हैं। यहाँ आपको डेवलपर गाइड, API संदर्भ और उन्हें बनाने के लिए उपयोग किए जाने वाले वर्कफ़्लो के बारे में जानकारी मिलेगी।
मैं NDA के कारण अपने अधिकांश काम को साझा नहीं कर सकता, लेकिन इस पोर्टफोलियो में मूल सामग्री शामिल है जो मेरे तकनीकी लेखन कौशल और प्रक्रियाओं को प्रदर्शित करती है।
पोर्टफोलियो नेविगेशन
गाइड
- Google Chrome में थीम इंस्टॉल करना और लागू करना
- Stripe API से कनेक्ट करने के लिए Postman का उपयोग करना
- Writage के साथ Microsoft Word से GitHub Wiki वर्कफ़्लो
- क्लाउड एप्लिकेशन लॉग को पाइपलाइन में रूट करना
- ट्यूटोरियल: ऑब्जेक्ट डेटा प्राप्त करना
- ट्यूटोरियल: ट्रांजेक्शन भेजना
API संदर्भ
- Stripe API प्रलेखन
- Pet Store API प्रलेखन
- स्ट्रीमिंग API के माध्यम से इवेंट इंजेशन
- SuiClient: getObject
- SuiClient: multiGetObjects
- SuiClient: getOwnedObjects
वैचारिक/अवलोकन दस्तावेज़
इन दस्तावेजों की मूल मार्कडाउन फाइलें देखने के लिए, GitHub पर जाएं।
प्रलेखन वर्कफ़्लो
- VS Code में Markdown के साथ ड्राफ्टिंग
- Vale के साथ Markdown लिंटिंग
- DeepL के साथ अनुवाद
- Mermaid के साथ आरेख निर्माण
- Git के साथ प्रलेखन वर्शनिंग
- Postman और Swagger/OpenAPI के साथ API सत्यापन
- Docusaurus के साथ प्रकाशन
तकनीकी स्टैक
- Docusaurus: स्टैटिक साइट और प्रलेखन उत्पन्न करने के लिए।
- VS Code: सभी सामग्री के लिए प्राथमिक संपादक।
- Postman: API परीक्षण और API प्रलेखन उदाहरण उत्पन्न करने के लिए।
- Vale: लिंटिंग और स्टाइल गाइड के पालन को सुनिश्चित करने के लिए।
- Git/GitHub: वर्शन कंट्रोल और होस्टिंग के लिए।
- Mermaid Chart: Mermaid कोड को छवियों में बदलना।
- DeepL MCP: कई भाषाओं में प्रलेखन के अनुवाद के लिए।
यह दर्शाता है कि पेशेवर टीमें Docusaurus या इसी तरह के स्टैटिक-साइट जनरेटर जैसे डेवलपर प्रलेखन पोर्टल कैसे बनाए रखती हैं।
प्रत्येक नमूना एंड-टू-एंड दस्तावेज़ निर्माण को प्रदर्शित करता है: शोध → ड्राफ्टिंग → समीक्षा → प्रकाशन।