# API documentation — Markdown और Documentation

Source: https://www.geekswithgeeks.com/hi/markdown-documentation/markdown-documentation-16

> API documentation को स्पष्ट goal और verify किए जा सकने वाले outcome के साथ लागू करें।

## API documentation को समझें

**API documentation** में पहले यह समझें कि वह कौन-सी समस्या हल करता है। Tool या workflow चुनने से पहले input, constraint और दिखने वाला result पहचानें। इससे आपका निर्णय समझाना और review करना आसान होगा।

## काम करने का path देखें

**API documentation** का अभ्यास इस path से करें: context समझें, एक focused बदलाव करें, result verify करें और फिर सीख लिखें।

![API documentation के लिए चार चरणों वाला अभ्यास workflow।](assets/figures/markdown-documentation/section-4-map.svg) — चित्र 4.1 — समझें, काम करें, verify करें और सुधारें।

## एक उपयोगी तुलना

**API documentation** यात्रा से पहले की checklist जैसा है: वह आपके लिए यात्रा नहीं कर सकता, लेकिन छोटी छूटी बात को महँगे surprise बनने से रोकता है।

Action के पीछे की reasoning जाँचें।

**Quiz:** API documentation का उपयोग करते समय सबसे मजबूत पहला step क्या है?

- [x] समस्या, constraint और सफलता का evidence तय करें।
- [ ] बिना पढ़े सबसे बड़ा example copy करें।
- [ ] समय बचाने के लिए verification छोड़ दें।

*Answer:* समस्या, constraint और सफलता का evidence तय करें।. स्पष्ट constraint और verify किया जा सकने वाला result workflow को विश्वसनीय बनाते हैं।