टर्नएपीआई - प्रलेखन आसानी से लिखें

क्या आप उस स्थिति से परिचित हैं जब प्रोजेक्ट लॉन्च को केवल इसलिए स्थगित कर दिया जाता है क्योंकि एपीआई या कुछ इसी तरह का प्रलेखन तैयार नहीं है? हो सकता है कि आपको उपयोगकर्ताओं, अभिगम अधिकारों और एक शक्तिशाली संपादक के साथ एक प्रलेखन प्रणाली विकसित करने में एक महीना बिताना पड़े? क्या आप स्वयं प्रलेखन पर काम करते हैं और इस दिनचर्या में निहित हैं? क्या आपने सभी सवालों के जवाब "हां" में दिए?

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

टर्नएपीआई क्या है?

टर्नएपीआई स्टार्टअप्स के लिए एक स्टार्टअप है। और यदि आपका स्टार्टअप एक RESTful API प्रदान करता है, तो हमारा स्टार्टअप इसके लिए उत्कृष्ट दस्तावेज बना देगा!

टर्नएपीआई प्रलेखन पर सहयोग करने, इसे समय पर ढंग से अपडेट करने और कई संस्करणों का समर्थन करने का एक तरीका है।

बीटा

हमारे पास प्रलेखन कार्य को अधिक सुविधाजनक और तेज़ बनाने के बारे में कई विचार हैं। यदि आप इस विषय पर अपने विचार साझा करते हैं तो हमें खुशी होगी। परियोजना पर काम जोरों पर है, लेकिन अब आप कुछ स्वादिष्ट सुविधाओं को आजमा सकते हैं।

सुविधाओं

क्या पहले से तैयार है:
- त्वरित लेखन प्रलेखन के लिए मार्कडाउन सिंटैक्स के साथ विकि संपादक
- अपने पसंदीदा संपादक या IDE में प्रलेखन लिखने के लिए git और svn एकीकरण
- प्रलेखन अद्यतन का ट्रैक रखने के लिए आरएसएस
- परियोजना के विभिन्न संस्करणों के लिए प्रलेखन के विभिन्न संस्करण
- परिवर्तन वापस करने के लिए संशोधन, और बैकअप न करें

यह योजना बनाई है:
- संपादक हॉटकी समर्थन
- "स्प्लिट मोड" - संपादक में एक नया देखने का तरीका
- एक दस्तावेज़ के विभिन्न संशोधनों की तुलना
- नई थीम
यहाँ अधिक जानकारी

रूसी भाषा ...

इस स्तर पर समर्थित नहीं है। हमने अंग्रेजी में पहला संस्करण बनाने का फैसला किया। बड़ी संख्या में लोगों के एकत्रित होते ही महान और शक्तिशाली के लिए समर्थन प्रकट होगा;)

% उपयोगकर्ता नाम%, आपकी राय हमारे लिए महत्वपूर्ण है!