في هذه الصفحة
المقدمة
في الوقت الحالي أصبح كتابة ال Documentation شئ أساسي في أي Code بنكتبه ، فأصبح من الضروري تعلم طرق كتابة ال Documentation بشكل احترافي ، بحيث تساعد اللي شغالين معاك في التيم انهم يشتغلوا بشكل افضل واسرع بدون الرجوع اليك كثيرا.
ال API Documentation هو شئ اساسي دلوقتي في اي مشروع كبير ، او اي مشروع قابل للتوسع ، استخدامك للتقنية ده بيسرع الشغل و بيحسن التفاهم بين تيم ال development كله
فرصة تكسب 8000 جنيه لو شغال Backend
نافس و اطور و 🏆 اكسب 8000 جنيه!
تقدر دلوقتى تشتغل على الـ Backend Task 💻 من Code Quest و تنافس ناس تانية 🤝، هتكتسب خبرة 📚 و تبني portfolio 💼 و كمان جوايز للمراكز الاولى 🥇🥈🥉.
ماتفوتش الفرصة 🚀 وسجل دلوقتي 🖊️
The Power of API Documentation
أكيد في بداية كتابك للكود ك NodeJS Developer قابلك مشكلة إنك تشرح الكود ده لحد معين .
لو اشتغلت مع تيم برمجة كبير يحتوي علي Frontend او حتي Backend داخل التيم جديد وعاوز تشرح له ال API اللي معمول ، هتحتاج مجهود كبير إنك تشرح له صح ؟
علشان كده ظهرت أهمية ال Documentation ، أو إنك توفر شرح جاهز لكل ال Routes وال Features بتاعت ال API بتاعك .
تعالي اقولك فوائد انك تكتب Documentation للكود بتاعك :
- بتحسن تجربة المطور اللي معاك ، بحيث إنها بتساعدهم على الفهم فتقلل وقت التجربة والخطأ .
- بتعزز التعاون بين الفريق ، بحيث إنها بتسهل الفهم والعمل بين ال Frontend وال Backend
- تعزيز قابلية التوسع ، التوثيق الجيد للكود بيساعد المطورين إنهم يطوروا في النظام بسهولة وتوسيعه.
SwaggerIO For Documentation
حلو جدا دلوقتي وصلنا إننا فهمنا أهمية ال Documentation أو التوثيق للكود بتاعنا ، دلوقتي نتكلم عن أداة هي الأشهر في التوثيق للكود بتاعنا وهي ( Swagger ) هي أداة من أشهر الادوات في توثيق ال APIs بتاعتك و ليها أكثر من ميزة منها :
- تقوم بإنشاء توثيقات جميلة وتفاعلية عن طريق ادوات مثل Swagger ui
- تختبر ال end points بتاعتك بسهوله من ال Browser
- تحافظ على تحديثات المستندات بتاعتك عن طريق ال comments اللي بتعملها بإستخدام Swagger JSDoc
تقدروا دلوقتي تشتركوا في النشرة الأسبوعية لاقرأ-تِك بشكل مجاني تمامًا عشان يجيلكوا كل جديد بشكل أسبوعي فيما يخص مواضيع متنوعة وبشروحات بسيطة وسهلة وبجودة عالية 🚀
النشرة هيكون ليها شكل جديد ومختلف عن شكلها القديم وهنحاول انها تكون مميزة ومختلفة وخليط بين المحتوى الأساسي اللي بينزل ومفاجآت تانية كتير 🎉
Eqraatech - اقرأ-تِك
في الختام
ال Documentation بقت جزء أساسي في أي مشروع كبير أو قابل للتوسعة ، لذلك يجب الإهتمام بكتابة توثيقات واضحة وسهلة للكود بتاعنا.
بكدة نكون فهمنا أهمية التوثيق للكود بتاعنا و ايه هي أهم الأدوات للتوثيق ده ، ونلقاكم في الجزء القادم مع أمثلة عملية للتوثيق من Node js applications .
