एक AI दस्तावेज़ीकरण सहायक बनाने ने मुझे तकनीकी लेखन के बारे में क्या सिखाया

अधिकांश तकनीकी लेखक AI एजेंट नहीं बनाते। हम उनका दस्तावेज़ीकरण करते हैं। हम स्प्रिंट समीक्षा में बैठते हैं। हम आर्किटेक्चर निर्णय रिकॉर्ड पढ़ते हैं। फिर हम यह तय करते हैं कि रिट्रीवल पाइपलाइन उस व्यक्ति को कैसे समझाएँ जिसे बस शुक्रवार तक अपना इंटीग्रेशन चलाना है।

फिर भी मैंने एक बनाया।

उसका नाम आर्टी है, एक AI दस्तावेज़ीकरण सहायक जिसे मैंने Algolia के साथ बनाया। वह इसी दस्तावेज़ीकरण साइट के भीतर चलता है। उसे बनाने ने मुझे लेखन और AI के बारे में किसी भी सम्मेलन वार्ता से कहीं ज़्यादा सिखाया।

यह आर्टी के डिज़ाइन का वॉकथ्रू नहीं है। केस स्टडी वह काम करती है। यह पोस्ट व्यापक सबक के बारे में है:

• AI एजेंट वास्तव में क्या हैं
• रिट्रीवल-ऑगमेंटेड जनरेशन व्यवहार में कैसे काम करता है
• प्रॉम्प्ट इंजीनियरिंग अधिकांश लोगों के अनुमान से कहीं ज़्यादा तकनीकी लेखन के करीब क्यों है
• और यह सब हमारे इस छोटे से काम के लिए क्या मायने रखता है

AI एजेंट क्या है और क्या नहीं

लोग "AI एजेंट" शब्द स्पेल-चेकर से लेकर ऑटोकम्प्लीट तक हर चीज़ पर लगा देते हैं। फ़र्क़ मायने रखता है। हर AI सुविधा एजेंट नहीं होती। मशीन लर्निंग वाला स्पेल-चेकर एजेंट नहीं है। ऑटोकम्प्लीट सुझाव भी नहीं है। और जो चैटबॉट एक जड़ निर्णय-वृक्ष का पालन करता है, वह टेक्स्ट बॉक्स लगा एक फ़्लोचार्ट भर है।

AI एजेंट वह सिस्टम है जो किसी परिभाषित वातावरण में किसी लक्ष्य को समझ सकता है और उस पर कार्य कर सकता है। सीमाओं के भीतर की स्वायत्तता ही एजेंट को प्रॉम्प्ट-रिस्पॉन्स लूप से अलग करती है। एजेंट संदर्भ पढ़ता है और रणनीति चुनता है, कभी-कभी एक से ज़्यादा चरणों में।

इस स्पेक्ट्रम पर आर्टी कहाँ बैठता है?

इस परिभाषा के हिसाब से वह एजेंट नहीं है। वह वेब नहीं ब्राउज़ करता, कोड नहीं चलाता, और कई चरणों वाले टूल कॉल नहीं जोड़ता। Algolia मॉडल चलने से पहले पेज निकाल लेता है। मॉडल उन्हें संदर्भ के रूप में पाता है। हाँ, वह अपने आप मंशा समझता है और गार्डरेल लागू करता है। वह जवाब देने से पहले तय करता है कि सवाल तकनीकी है या पोर्टफ़ोलियो से जुड़ा। यह टेक्स्ट फ़ील्ड वाले सर्च बॉक्स से ज़्यादा है। और पूरी तरह स्वायत्त एजेंट से कम है, जो मान लीजिए उपयोगकर्ता के सवाल से बग रिपोर्ट खोल सके।

तकनीकी लेखकों को अब यह अंतर चाहिए। AI टूल और एजेंट समझना काम का हिस्सा है। जब आप AI वाला उत्पाद लिखते हैं, तो आपको पता होना चाहिए कि वह इस स्पेक्ट्रम पर कहाँ है। फिर आपको उपयोगकर्ताओं को बताना होता है कि उस उत्पाद में "AI" का मतलब क्या है, क्योंकि उनकी अपेक्षाएँ अलग-अलग होती हैं।

रिट्रीवल-ऑगमेंटेड जनरेशन कैसे काम करता है

रिट्रीवल-ऑगमेंटेड जनरेशन (RAG) आर्टी को और बढ़ती संख्या में AI दस्तावेज़ीकरण टूल को चलाता है। RAG बड़े भाषा मॉडल (LLM) की एक मूल सीमा से बचाता है। मॉडल एक स्थिर डेटासेट पर प्रशिक्षित होता है। आपकी सामग्री उसके प्रशिक्षण डेटा में नहीं होती।

LLM के साथ सामान्य बातचीत ऐसे होती है: उपयोगकर्ता प्रॉम्प्ट भेजता है, और मॉडल अपने प्रशिक्षण डेटा से जवाब बनाता है। यह सामान्य ज्ञान के लिए ठीक है और किसी ख़ास क्षेत्र के सवालों पर विफल रहता है। किसी बेस मॉडल से अपने उत्पाद की API के बारे में पूछिए, तो वह या तो जवाब गढ़ लेगा या मना कर देगा।

RAG उपयोगकर्ता के सवाल और मॉडल के जवाब के बीच एक रिट्रीवल चरण जोड़ता है। पाइपलाइन ऐसी दिखती है:

1. क्वेरी प्रोसेसिंग। रिट्रीवल लेयर उपयोगकर्ता के सवाल को वेक्टर एम्बेडिंग में बदल देती है, यानी उसके अर्थ का संख्यात्मक निरूपण।
2. पुनर्प्राप्ति। सिस्टम ज्ञान आधार में मिलते-जुलते अर्थ वाली सामग्री खोजता है। यहाँ ज्ञान आधार आपके दस्तावेज़ों का पहले से बना इंडेक्स है। रैंकिंग अर्थ पर निर्भर करती है, अक्सर कीवर्ड मिलान के साथ। "मैं प्रमाणीकरण कैसे सेट करूँ?" और "लॉगिन क्रेडेंशियल कॉन्फ़िगर करें" जैसी क्वेरी एक ही दस्तावेज़ पेज लौटाती हैं।
3. संदर्भ असेंबली। सिस्टम मिले हुए दस्तावेज़ों, या उनके टुकड़ों, को उपयोगकर्ता के सवाल और सिस्टम प्रॉम्प्ट के साथ एक संदर्भ विंडो में पैक करता है। फिर मॉडल उस पैकेज को प्रोसेस करता है।
4. जनरेशन। मॉडल अपने प्रशिक्षण डेटा के बजाय मिले संदर्भ पर आधारित जवाब बनाता है। ठीक से ट्यून किए सिस्टम में मॉडल अपने स्रोत बताता है और मिले दस्तावेज़ों की सीमा में रहता है।

Mermaid (image)

Mermaid (code)

flowchart TD
    A["🔍 उपयोगकर्ता का प्रश्न"] --> B["क्वेरी प्रोसेसिंग"]
    B -->|वेक्टर एम्बेडिंग| C["पुनर्प्राप्ति"]
    KB[("📚 ज्ञान आधार")] -.-> C
    C -->|संबंधित दस्तावेज़| D["संदर्भ असेंबली"]
    D -->|प्रॉम्प्ट + संदर्भ| E["जनरेशन"]
    E --> F["📄 प्रमाणित उत्तर"]

गुणवत्ता चरण 2 पर टिकी है। अगर रिट्रीवल लेयर गलत दस्तावेज़ लौटाती है, या उन्हें बुरी तरह रैंक करती है, तो मॉडल की क्षमता काम नहीं आती। मॉडल गलत सामग्री से एक विश्वसनीय और सुगठित जवाब लिख देता है। इसलिए चंकिंग और एम्बेडिंग मॉडल का चुनाव अधिकांश टीमों की अपेक्षा ज़्यादा मायने रखता है। श्रेय जनरेशन मॉडल को मिलता है, पर गुणवत्ता रिट्रीवल लेयर तय करती है।

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

प्रॉम्प्ट इंजीनियरिंग तकनीकी लेखन है

प्रोजेक्ट ने मुझे एक बड़ा सबक दिया। सिस्टम प्रॉम्प्ट एक तकनीकी लेखन डिलीवरेबल है।

एक अच्छी तरह लिखा सिस्टम प्रॉम्प्ट वही हिस्से रखता है जो एक स्टाइल गाइड रखती है। आप दर्शक तय करते हैं। आप स्वर और आवाज़ के नियम बनाते हैं। आप दायरे की सीमाएँ तय करते हैं: सिस्टम को क्या संभालना है और क्या नहीं। आप ऐसे निर्देश लिखते हैं जो इतने सटीक हों कि मशीन मानवीय निर्णय के बिना उनका पालन कर सके। आप जानकारी को इस तरह क्रम में रखते हैं कि सबसे ज़रूरी नियम पहले आएँ।

यह काम दर्शक विश्लेषण और स्टाइल गाइड है। यह सामग्री योजना भी है।

कौशल का हस्तांतरण लगभग एक-के-एक है:

• दर्शक विश्लेषण → दर्शक रूटिंग। तकनीकी लेखक दर्शक पहचानते हैं और सामग्री उसी के अनुसार ढालते हैं, और सिस्टम प्रॉम्प्ट AI के लिए वही करता है। आर्टी का प्रॉम्प्ट तकनीकी उपयोगकर्ताओं और भर्तीकर्ताओं के बीच रास्ता बाँटता है, जैसे एक सुगठित दस्तावेज़ीकरण साइट पाठक प्रोफ़ाइलों के बीच बाँटती है।
• स्टाइल गाइड → पर्सोना कैलिब्रेशन। हर दस्तावेज़ीकरण टीम के पास स्वर और आवाज़ के दिशानिर्देश होते हैं। सिस्टम प्रॉम्प्ट AI के लिए स्टाइल गाइड है। यह हर दर्शक के लिए स्वर सेट करता है और हर दावे के लिए स्रोत लिंक माँगता है।
• सूचना आर्किटेक्चर → निर्देश पदानुक्रम। तकनीकी लेखक जानते हैं कि क्रम और संरचना समझ को प्रभावित करते हैं। निर्देश की जगह बदलती है तो मॉडल उसे कितनी अच्छी तरह मानता है, वह भी बदलता है।
• सीमांत स्थितियों का दस्तावेज़ीकरण → गार्डरेल डिज़ाइन। अच्छा दस्तावेज़ीकरण अनपेक्षित क्रिया को स्पष्ट मार्गदर्शन के साथ कवर करता है। अच्छा प्रॉम्प्ट डिज़ाइन उस उपयोगकर्ता को कवर करता है जो सिस्टम तोड़ने की कोशिश करता है।

हर तकनीकी लेखक को प्रॉम्प्ट इंजीनियर बनने की ज़रूरत नहीं है। यह अनुशासन उन कौशलों से उधार लेता है जो तकनीकी लेखक दशकों में बनाते हैं। अगर आप स्पष्ट, सुगठित और दर्शक-सजग दस्तावेज़ लिख सकते हैं, तो आप इस काम में आपकी सोच से ज़्यादा लेकर आते हैं।

गार्डरेल एक भाषा की समस्या है

लोग AI सुरक्षा को तकनीकी समस्या मानते हैं: दर सीमाएँ, लॉगिन, एक्सेस नियंत्रण। ये सब मायने रखते हैं। सार्वजनिक चैटबॉट में हमलावर जिस चीज़ को निशाना बनाते हैं, उसका बड़ा हिस्सा भाषाई होता है।

जानकारी

प्रॉम्प्ट इंजेक्शन तब होता है जब उपयोगकर्ता सिस्टम प्रॉम्प्ट को ओवरराइड कर देता है। आम उदाहरण यह वाक्य है: "पिछले सभी निर्देशों को अनदेखा करें।"

प्रॉम्प्ट इंजेक्शन शब्दों का इस्तेमाल शब्द-आधारित नियंत्रणों को घुमाने के लिए करता है। बचाव का मतलब है ऐसे नियम लिखना जो इतने स्पष्ट हों कि हमलावर मॉडल को उनसे आगे न ले जा सके।

Open Worldwide Application Security Project (OWASP) की LLM ऐप्स के लिए शीर्ष 10 जोखिमों की सूची प्रॉम्प्ट इंजेक्शन को पहला जोखिम बताती है। उस सूची को पढ़िए और आप देखेंगे कि कितने जोखिम जड़ में भाषा की समस्याएँ हैं:

• अनुचित आउटपुट हैंडलिंग (मॉडल क्या निकालता है)
• डेटा और मॉडल ज़हरीकरण (मॉडल ने पाठ से क्या सीखा)
• अत्यधिक एजेंसी (प्रॉम्प्ट मॉडल को बताता है कि वह क्या कर सकता है)

हमले तकनीकी हैं। बचाव अक्सर सादी भाषा में होते हैं, सिस्टम प्रॉम्प्ट के भीतर लिखे हुए।

इससे तकनीकी लेखकों के लिए सुरक्षा काम नए तरीके से दिखता है। कोई हमसे प्रमाणीकरण प्रणालियाँ बनाने की अपेक्षा नहीं करता। लेकिन हम वे नियम लिख सकते हैं जो तय करते हैं कि AI कैसे जवाब दे। हम उन्हें इतनी सटीकता से लिख सकते हैं कि वे विरोधी इनपुट का सामना कर सकें।

दस्तावेज़ीकरण काम में क्या बदलता है

मैं AI का भविष्य नहीं बताऊँगा। मैं आज दिख रही दिशा बता सकता हूँ और यह उन लोगों के लिए क्या मायने रखती है जो गुज़ारा चलाने के लिए सॉफ़्टवेयर का दस्तावेज़ीकरण करते हैं।

AI दस्तावेज़ीकरण सहायक नई चीज़ से अपेक्षित चीज़ बन गए हैं। उपयोगकर्ता अब स्थिर खोज स्वीकार नहीं करते। वे सीधा सवाल पूछना चाहते हैं और दस नीले लिंक की जगह तथ्य-आधारित जवाब पाना चाहते हैं। RAG सिस्टम यह आज संभव बनाते हैं। टूल अपनाना लगातार आसान होता जा रहा है।

सुझाव

इंफ़्रास्ट्रक्चर पक्ष देखना है? इवेंट स्ट्रीम और ऑब्ज़र्वेबिलिटी पाइपलाइन दस्तावेज़ दिखाते हैं कि Datadog और Galileo मॉडल कॉल कैसे ट्रैक करते हैं।

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

तकनीकी लेखकों को सीखना चाहिए कि LLM और RAG सिस्टम कैसे काम करते हैं। हमें मशीन लर्निंग इंजीनियर बनने की ज़रूरत नहीं, पर AI उत्पादों पर बातचीत में हमें शामिल होना चाहिए। हमें पाइपलाइन की इतनी समझ चाहिए कि हम जान सकें कि हमारी विशेषज्ञता कहाँ लागू होती है और कहाँ नहीं।

तकनीकी लेखक पहले से कई दर्शकों के लिए लिखते हैं। वे सामग्री को ढाँचा देते हैं और दायरा तय करते हैं। वे दुरुपयोग की योजना बनाते हैं। ये कौशल AI के काम में सीधे लागू होते हैं।

AI तकनीकी लेखकों की जगह नहीं लेगा। मॉडल हर साल टेक्स्ट बनाने में बेहतर होते हैं, पर फिर भी कोई तय करता है कि क्या कहना है, किससे कहना है, और किन सीमाओं में।

उन्हें संपादक चाहिए। संपादक हम हैं।

पहला ड्राफ़्ट ख़ुद लिखना भी काम करता है। फिर AI एजेंट को उस पर प्रूफ़रीडर और स्टाइल जाँचकर्ता की तरह लगाइए।

अपने काम के प्रवाह में AI कैसे इस्तेमाल करें, यह आपका फ़ैसला है, हमारे पास मौजूद हर दूसरे टूल की तरह।

काम नहीं बदल रहा। टूल बदल रहे हैं। काम कहीं नहीं जा रहा। जो टीमें अपने तकनीकी लेखकों को हटाती हैं, वे उन्हें वापस बुलाती हैं।

केस स्टडी पढ़ें

अगर इस पोस्ट ने आपको "यह क्यों मायने रखता है" और "यह कैसे काम करता है" दिया, तो केस स्टडी पढ़िए। वह आर्टी के पीछे के ठोस डिज़ाइन निर्णय बताती है:

• दर्शक रूटिंग
• ज्ञान आधार
• पर्सोना कैलिब्रेशन
• सुरक्षा गार्डरेल
• वे समझौते जिन पर मैं प्रोडक्शन डिप्लॉयमेंट के लिए दोबारा सोचूँगा

हर हिस्सा अपने आप चलता है। जो आपको ज़्यादा खींचे, उससे शुरू कीजिए।