स्मरण पुनर्प्राप्ति
पैरामीटर से त्रुटि कोड तक, याद न रह सकने वाली जानकारी फिर पाएँ।
वर्षों तक उपयोग के बाद दस्तावेज़ों को जीवित रखने वाली चीज़ों में से एक संदर्भ के रूप में उनका मूल्य है। हम मैनुअल के पृष्ठों को उन सूचनाओं को याद करने, पुनः प्राप्त करने या खोजने के लिए देखते हैं जिन्हें हम याद नहीं रख सके—पैरामीटर से लेकर त्रुटि कोड और स्वीकार्य मानों तक।
स्मरण को संबोधित करने वाले दस्तावेज़ों के उदाहरण Dockerfile reference और GitLab CI/CD YAML syntax reference हैं। वे उन छोटी-छोटी बातों के बारे में आसानी से खोजी जा सकने वाली, अत्यधिक संरचित जानकारी देते हैं जिन्हें उपयोगकर्ता को विभिन्न तकनीकी “मंत्र” चलाने के लिए याद करना पड़ता है।
संदर्भ दस्तावेज़ीकरण दीर्घकालिक उत्पाद उपयोगिता की आधारशिला है। दूसरी क्रियाओं को पूरा करने के लिए बनाए दस्तावेज़ एक बार पढ़कर आत्मसात किए जा सकते हैं, पर संदर्भ सामग्री उपयोगकर्ताओं की विशेषज्ञता बढ़ने और जटिल कार्यान्वयनों से निपटने के साथ लगातार मूल्यवान रहती है।
उपयोगकर्ता क्या करना चाहता है
संदर्भ सामग्री वर्षों तक दस्तावेज़ों को उपयोगी रखती है। उपयोगकर्ता उन सूचनाओं को याद करने, पुनः प्राप्त करने या खोजने के लिए मैनुअल देखते हैं जिन्हें वे याद नहीं रख सके।
संकेत कि आपके दस्तावेज़ इस आवश्यकता को पूरा नहीं करते
- उपयोगकर्ता किसी पैरामीटर या त्रुटि कोड को खोजते हैं और कुछ नहीं मिलता।
- संदर्भ सामग्री ब्लॉग पोस्ट और चैट लॉग में बिखरी हुई है।
- उत्पाद के सिंटैक्स या सेटिंग के लिए खोजने योग्य, संरचित संदर्भ नहीं है।
वास्तविक दुनिया के दो उदाहरण
सामान्य सामग्री प्रकार
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <reference>, <refsyn>, <properties> | संदर्भ | संदर्भ, शब्दावली |
एक मेट्रिक
संदर्भ सफलता दर · सही पृष्ठ देने वाली संदर्भ खोजों का अनुपात।