Importance of Documentation For Software Engineers

المقدمة

كل الـ Software Engineers شاطرين في كتابة الكود، لكن لو عايز تتطور أكتر، لازم تطور مهارات كتابة الـ Documentation عندك. علشان كده، ورقة وقلم، وخليني أحاول أقنعك ليه لازم تنمي المهارة دي (آه، الكتابة مهارة لازم تجرب وتحاول كتير علشان تتقنها).

ليه تكتب؟

الكتابة بتنظم أفكارك. لسبب ما، إحنا كبشر بنفتكر إن القراءة = معرفة. يعني لو قرأت دليل البداية لـ Javascript يبقى كده أنا فاهم. قرأت مقال عن TCP/IP يبقى كده خلاص! بس الحقيقة مش كده.

لو كان ده حقيقي، كنا كلنا عباقرة. اللي فعلاً بيثبت المعلومة هو الكتابة والتجربه. عشان كده أنا مؤمن بإنك تكتب الكود بإيدك بدل ما تنسخ كود جاهز. الكتابة بتثبّت المعلومة في دماغك.

الكتابة طريقة لتعلم حاجة جديدة لو عايز تتعلم حاجة جديدة، اكتب عنها. ودايمًا خلي الكتابة بتاعتك حقيقية، يعني كتابة فيها بحث وتفاصيل صح. الكتابة الحقيقية هتخليك تجرّب وتتعلم أكتر.

الكتابة بتساعدك تكتشف الأخطاء كام مرة طُلب منك تكتب Technical Documentation وقلت لنفسك: "ليه؟ الـ Feature دي سهلة، حافظها في دماغي والتيم كله عارفها."

ده تفكير غلط بنقع فيه كلنا ، لو كتبنا الـ Document صح، هنلاقي مشاكل كتير في التصميم "السهل" ده، زي تناقضات أو تفاصيل ناقصة أو حتى تفكير غلط بسبب الكسل.

ازاي تكتب أكتر؟

الكتابة زي ما قلنا مهارة. وعلشان تتقنها، لازم تكتب أكتر. طريقة بسيطة إنك تتعامل مع Documents بحماس بدل ما تكرهها. كل مرة تكتب Document حاول تحسن حاجة. خليها أقصر بس من غير ما تفقد المعنى، أو خليها أطول عشان تغطي تفاصيل أكتر.
كتابة توثيقات أو مراجعات في شغلك طريقة سهلة تخليك تكتب أكتر. هتعملها في كل الأحوال، طب ليه ما تحسنش وانت بتكتب؟ ولو عايز تطور مهاراتك في الكتابة برا شغلك، فكر تبدأ مدونة، أو جاوب على أسئلة في Stackoverflow. ركّز إنك تقدم محتوى نصي حقيقي مش مجرد نسخ ولصق كود.
الكتابة لا مفر منها سواء عاجبك أو لأ، لو عايز تبقى مهندس مميز ، هتضطر تكتب. كل ما تطور مهارات الكتابة بسرعة، كل ما تبقى مهندس أفضل بسرعة.

تقدروا دلوقتي تشتركوا في النشرة الأسبوعية لاقرأ-تِك بشكل مجاني تمامًا عشان يجيلكوا كل جديد بشكل أسبوعي فيما يخص مواضيع متنوعة وبشروحات بسيطة وسهلة وبجودة عالية 🚀

النشرة هيكون ليها شكل جديد ومختلف عن شكلها القديم وهنحاول انها تكون مميزة ومختلفة وخليط بين المحتوى الأساسي اللي بينزل ومفاجآت تانية كتير 🎉

بفضل الله قمنا بإطلاق قناة اقرأ-تِك على التليجرام مجانًا للجميع 🚀

آملين بده اننا نفتح باب تاني لتحقيق رؤيتنا نحو إثراء المحتوى التقني باللغة العربية ، ومساعدة لكل متابعينا في انهم يوصلوا لجميع أخبار اقرأ-تِك من حيث المقالات ومحتوى ورقة وقلم والنشرة الأسبوعية وكل جديد بطريقة سريعة وسهلة

مستنينكوا تنورونا , وده رابط القناة 👇

https://t.me/eqraatechcom

Join us on Telegram Channel

نصايح ممكن تخلي بالك منها علشان تبدا في توثيق اي مشروع

متحاولش تعمل كل حاجة مرة واحدة. اختار جزء معين من المشروع أو المنتج وابدأ بيه. خطوة بخطوة هتقدر تبني الوثائق. متخليش حجم الشغل يخوفك. وأهم حاجة، ابدأ النهارده. متستناش اللحظة المناسبة أو الحل المثالي، لإن مفيش حاجة اسمها كده. الـ Documentation دايمًا بيتحسن مع الوقت.
وثّق الحاجات اللي تهم , ركز على توثيق التفاصيل اللي فعلاً مهمة لأي تغيير في النظام أو السوفت وير،
متضيعش وقتك في توثيق تفاصيل هتبقى قديمة بسرعة. ركز على الميزات اللي فعلًا اتنفذت والتغييرات الضرورية. حافظ على توثيقك بسيط، لكن كافي إنه يساعدك إنت والفريق دلوقتي من غير ما يبقى تقيل وصعب تحديثه.
متستناش لحد ما التوثيق يبقى مثالي. شارك الوثائق مع زملائك بدري علشان تاخد منهم ملاحظات وتعديلات. متخليش الوثائق تفضل مهملة في ركن بعيد. شاركها مع الفريق وكل الأطراف التانية اللي ليهم علاقة.
لازم يبقى فيه حد مسؤول عن جودة ودقة التوثيق في الفريق. مش معنى كده إن الباقي مش عليهم مسؤولية، لكن الشخص المسؤول ده هيتأكد إن الوثائق بتخدم الفريق وتبقى محدثة دايمًا.