नमूना डेटा के साथ एक एल्गोरिथ्म को ठीक से कैसे दस्तावेज़ित करें?

Question

मैं सोच रहा हूँ कि एक एल्गोरिथ्म प्रलेखन में क्या होना चाहिए? अनुसरण करने के लिए एक उचित दिशानिर्देश का पता नहीं लगा सकते। मुझे शामिल करने का मन है

• एल्गोरिथ्म का सारांश
• एल्गोरिथ्म का वर्णन
• फ़्लोचार्ट
• छद्म कोड
• नमूना इनपुट डेटा सेट (एकाधिक)
• उत्पादित आंकड़े
• इकाई परीक्षण
• प्रयोगों

ग्राहक इस तरह के प्रलेखन का अनुरोध करता है: अपने स्वयं के नंबरों पर विश्वास बनाए रखने के साथ-साथ संभावित ग्राहकों के लिए हमारी प्रक्रिया का वर्णन करें ताकि वे जान सकें कि हम अपनी गणना की जांच करने और सत्यापित करने के लिए कदम उठा रहे हैं।

• ऐसे दस्तावेज कैसे दिखेंगे? (उदाहरण पीडीएफ)
• आप इस दस्तावेज़ में और क्या शामिल करेंगे?
• मैंने जो कहा है वह अच्छा है, या यह किसी भी तरह से अलग दस्तावेज होना चाहिए?
• आप ऐसे प्रलेखन नमूनों के लिए Google में कैसे खोज करेंगे?

Answer 1

कुछ और बिंदु:

1. नमूना इनपुट और वातावरण के साथ प्रदर्शन विश्लेषण / बेंचमार्क।
2. एल्गोरिथ्म के विकल्प (यदि मौजूद है), वास्तव में नए लोगों के लिए, और तुलना विश्लेषण के लिए मदद करता है।
3. सर्वोत्तम और सबसे खराब स्थिति / आदानों के उदाहरण।

ऐसे दस्तावेज कैसे दिखेंगे?
Cusotmers / Users (/ मैनेजर्स?) PDF पसंद नहीं करते हैं, वे PPTs को बहुत दिलचस्प पाते हैं, हालांकि उसी समय व्यवसाय PDF पर जोर देगा। इसलिए आपके पास दो-स्तरीय दस्तावेज़ होना चाहिए, एक पीपीटी में "20 मिनट में व्याख्या करने के लिए" और दूसरे में पीडीएफ जो गेम के विवरण को कवर करता है।

Comments

इसके अलावा, यदि वैकल्पिक अल्गोस उपलब्ध हैं, तो आपको दोनों आलगोस की दक्षता की तुलना करनी चाहिए।

किसी भी नमूने आप दिखा सकते हैं?

— पेंटियम 10