دليل شامل للكتابة التقنية للمبتدئين: احتراف تدوين المحتوى التقني من الألف إلى الياء
Aldawsari 
إذا كنت شغوفًا بالكتابة والتقنية، فقد تكون الكتابة التقنية مسارًا وظيفيًا مثاليًا لك. إنها أيضًا فرصة رائعة لمن يحبون التكنولوجيا ولكن لا يميلون إلى قضاء ساعات طويلة في البرمجة. قد تكون الكتابة التقنية مناسبة لك أيضًا إذا كنت تستمتع بالتعلم من خلال تعليم الآخرين، أو المساهمة في مشاريع المصادر المفتوحة، أو ببساطة تبسيط المفاهيم المعقدة عبر كتاباتك.
دعنا نتعمق في الأساسيات ونستكشف ما يجب أن تعرفه وتضعه في اعتبارك عند البدء في رحلة الكتابة التقنية.
جدول المحتويات
- ما هي الكتابة التقنية؟
- فوائد الكتابة التقنية
- المهارات الأساسية للكاتب التقني
- عملية الكتابة التقنية خطوة بخطوة
- منصات لنشر مقالاتك التقنية
- دورات تدريبية في الكتابة التقنية
- منتديات ومجتمعات الكتابة التقنية
- كتاب تقنيون ملهمون لمتابعتهم
- الخلاصة التقنية
ما هي الكتابة التقنية؟
الكتابة التقنية هي فن تقديم إرشادات مفصلة وموجهة لمساعدة المستخدمين على فهم مهارة معينة أو منتج تقني. والكاتب التقني هو الشخص الذي يقوم بصياغة هذه الإرشادات، والتي تُعرف أيضًا باسم الوثائق التقنية أو الدروس التعليمية. يمكن أن تشمل هذه الوثائق أدلة المستخدم، مقالات الدعم عبر الإنترنت، أو الوثائق الداخلية للمطورين ومبرمجي واجهات برمجة التطبيقات (API).
يهدف الكاتب التقني إلى إيصال المعلومات التقنية بطريقة تمكن القارئ من استخدامها لتحقيق غرض محدد، مع التركيز على الوضوح والدقة.
فوائد الكتابة التقنية
الكتاب التقنيون هم متعلمون مدى الحياة. نظرًا لأن هذه المهنة تتطلب تبسيط المفاهيم المعقدة وتقديمها بوضوح ومباشرة، يجب أن تكون ملمًا بالمجال الذي تكتب عنه، أو على الأقل مستعدًا للتعلم المستمر. وهذا أمر رائع، فمع كل وثيقة تقنية جديدة تبحث عنها وتكتبها، ستصبح خبيرًا في ذلك الموضوع.
تنمي الكتابة التقنية أيضًا حسًا أفضل بالتعاطف مع المستخدم. فهي تساعدك على الانتباه أكثر لما يشعر به القراء أو مستخدمو المنتج، بدلًا من التركيز على ما تعتقده أنت. يمكنك أيضًا تحقيق دخل مادي ككاتب تقني من خلال المساهمة في مؤسسات وشركات مختلفة. من أبرز هذه المنظمات التي تدفع مقابل الكتابة: Smashing Magazine، Auth0، Twilio، و Stack Overflow.
بالإضافة إلى ذلك، يمكنك المساهمة في مجتمعات المصادر المفتوحة والمشاركة في برامج مدفوعة مثل Google Season of Docs و Outreachy. كما يمكن أن تصبح الكتابة التقنية مهنة بدوام كامل، حيث تحتاج العديد من الشركات إلى متخصصين يمتلكون هذه المهارات.
المهارات الأساسية للكاتب التقني
إتقان اللغة العربية الفصحى وقواعدها
قبل التفكير في الكتابة، من الضروري أن تكون لديك معرفة جيدة باللغة العربية الفصحى، تركيب الجمل، الإملاء، والقواعد النحوية الأساسية. قراؤك لا يرغبون في قراءة مقال مليء بالأخطاء اللغوية أو اختيار الكلمات غير المناسب. الوضوح والدقة يبدآن من إتقان اللغة.
القدرة على الشرح بوضوح وتبسيط
معرفتك بكيفية تنفيذ ميزة معينة لا تعني بالضرورة أنك تستطيع توصيل هذه العملية بوضوح للآخرين. لكي تكون معلمًا جيدًا، يجب أن تكون متعاطفًا، ولديك القدرة على شرح المصطلحات والمفاهيم بطرق مناسبة لجمهورك المستهدف. كما قال ألبرت أينشتاين:
«إذا لم تستطع شرحها لطفل في السادسة من عمره، فأنت لا تفهمها بنفسك.»
امتلاك مهارات الكتابة
أعتقد أن الكتاب يولدون من خلال الممارسة، لا بالولادة. ولا يمكنك تعلم الكتابة إلا من خلال الكتابة الفعلية. قد لا تكتشف أبدًا موهبتك في الكتابة حتى تمسك القلم وتبدأ. وهناك طريقة واحدة فقط لمعرفة ما إذا كانت لديك مهارات كتابة، وهي أن تكتب. لذا، أشجعك على البدء في الكتابة اليوم. يمكنك اختيار البدء بأي من المنصات التي سأذكرها لاحقًا لتنمية عضلاتك الكتابية.
وبالطبع، من المفيد جدًا أن تكون لديك بعض الخبرة في مجال تقني.
عملية الكتابة التقنية خطوة بخطوة
تحليل وفهم جمهورك المستهدف
العامل الأكبر الذي يجب مراعاته عند كتابة مقال تقني هو جمهورك المقصود/المتوقع. يجب أن يكون هذا دائمًا في مقدمة تفكيرك. الكاتب التقني الجيد يكتب بناءً على سياق القارئ.
على سبيل المثال، إذا كنت تكتب مقالًا يستهدف المبتدئين، فمن المهم ألا تفترض أنهم يعرفون بالفعل مفاهيم معينة. يمكنك بدء مقالك بتحديد أي متطلبات مسبقة ضرورية. هذا يضمن أن يكون لدى قرائك المعرفة التي يحتاجونها قبل التعمق في مقالك. يمكنك أيضًا تضمين روابط لموارد مفيدة حتى يتمكن قراؤك من الحصول على المعلومات التي يحتاجونها بنقرة واحدة.
لمعرفة لمن تكتب، يجب عليك جمع أكبر قدر ممكن من المعلومات حول من سيستخدم الوثيقة. من المهم معرفة ما إذا كان جمهورك لديه خبرة في المجال، أو إذا كان الموضوع جديدًا تمامًا عليهم، أو إذا كانوا يقعون في مكان ما بينهما. سيكون لقرائك أيضًا توقعات واحتياجات خاصة بهم. يجب أن تحدد ما يبحث عنه القارئ عندما يبدأ في قراءة الوثيقة وما سيستفيد منه.
لفهم قارئك، اسأل نفسك الأسئلة التالية قبل البدء في الكتابة:
- من هم قرائي؟
- ماذا يحتاجون؟
- أين سيقرأون؟
- متى سيقرأون؟
- لماذا سيقرأون؟
- كيف سيقرأون؟
تساعدك هذه الأسئلة أيضًا على التفكير في تجربة القارئ أثناء قراءته لكتاباتك، وهو ما سنتحدث عنه أكثر الآن.
التفكير في تجربة المستخدم (UX)
تجربة المستخدم لا تقل أهمية في الوثيقة التقنية عنها في أي مكان آخر على الويب. الآن بعد أن عرفت جمهورك واحتياجاتهم، ضع في اعتبارك كيف تلبي الوثيقة نفسها هذه الاحتياجات. من السهل جدًا تجاهل كيفية استخدام القارئ للوثيقة فعليًا. أثناء الكتابة، تراجع باستمرار وانظر إلى الوثيقة كما لو كنت أنت القارئ. اسأل نفسك:
- هل هي سهلة الوصول؟
- كيف سيستخدمها قرائك؟
- متى سيستخدمونها؟
- هل هي سهلة التنقل؟
الهدف هو كتابة وثيقة مفيدة وسهلة الاستخدام لقرائك.
تخطيط وثيقتك
مع الأخذ في الاعتبار من هم مستخدموك، يمكنك بعد ذلك تصور وتخطيط وثيقتك. تتضمن هذه العملية عددًا من الخطوات، والتي سنتناولها الآن.
إجراء بحث شامل حول الموضوع
أثناء تخطيط وثيقتك، يجب عليك البحث في الموضوع الذي تكتب عنه. هناك الكثير من الموارد على بعد بحث واحد في جوجل يمكنك استهلاكها والحصول على رؤى أعمق منها. لا تنجرف وراء إغراء نسخ أعمال أو مقالات الآخرين وتقديمها على أنها خاصة بك، فهذا يعد سرقة أدبية. بدلًا من ذلك، استخدم هذه الموارد كمراجع وأفكار لعملك. ابحث في جوجل قدر الإمكان، احصل على الحقائق والأرقام من المجلات البحثية، الكتب أو الأخبار، واجمع أكبر قدر ممكن من المعلومات حول موضوعك. ثم يمكنك البدء في وضع مخطط تفصيلي.
إنشاء مخطط تفصيلي
يساعدك تحديد محتوى وثيقتك قبل التوسع فيه على الكتابة بطريقة أكثر تركيزًا. كما يتيح لك تنظيم أفكارك وتحقيق أهدافك من الكتابة. يمكن أن يساعدك المخطط التفصيلي أيضًا في تحديد ما تريد أن يستفيده قرائك من الوثيقة. وأخيرًا، يحدد جدولًا زمنيًا لإكمال كتاباتك.
الحصول على رسوم بيانية/صور ذات صلة
يعد وجود مخطط تفصيلي مفيدًا جدًا في تحديد المساعدات البصرية المختلفة (الرسوم البيانية، صور GIF المتحركة، مقاطع الفيديو، التغريدات) التي ستحتاج إلى تضمينها في أقسام مختلفة من وثيقتك. وسيجعل عملية الكتابة أسهل بكثير إذا أبقيت هذه الرسوم البيانية ذات الصلة في متناول اليد.
الكتابة بالأسلوب الصحيح
أخيرًا، يمكنك البدء في الكتابة! إذا أكملت كل هذه الخطوات، يجب أن تصبح الكتابة أسهل بكثير. ولكن لا يزال يتعين عليك التأكد من أن أسلوب كتابتك مناسب لوثيقة تقنية. يجب أن تكون الكتابة سهلة الوصول، مباشرة، واحترافية. النصوص المزخرفة أو العاطفية غير مرحب بها في الوثيقة التقنية. لمساعدتك في الحفاظ على هذا الأسلوب، إليك بعض الخصائص الرئيسية التي يجب أن تنميها.
استخدام المبني للمعلوم (Active Voice)
من الجيد استخدام صيغة المبني للمعلوم في مقالاتك، حيث يسهل قراءتها وفهمها من صيغة المبني للمجهول (Passive Voice). تعني صيغة المبني للمعلوم أن فاعل الجملة هو من يقوم بالفعل بنشاط. بينما تعني صيغة المبني للمجهول أن الفاعل هو المتلقي لفعل الفعل.
إليك مثال على صيغة المبني للمجهول:
يجب قراءة الوثائق ست مرات في السنة من قبل كل مطور ويب.
وإليك مثال على صيغة المبني للمعلوم:
يجب على كل مطور ويب قراءة هذه الوثائق 6 مرات في السنة.
اختيار كلماتك بعناية
اختيار الكلمات مهم. تأكد من استخدام أفضل كلمة للسياق. تجنب الإفراط في استخدام الضمائر مثل ‘هذا’ و ‘ذلك’ حيث قد يجد القارئ صعوبة في تحديد الأسماء التي تشير إليها. تجنب أيضًا اللغة العامية والكلمات المبتذلة – تذكر أنك تكتب لجمهور أوسع قد تختلف ميولهم الثقافية عن ميولك.
تجنب المصطلحات المعقدة المفرطة (Jargon)
إذا كنت خبيرًا في مجالك، فقد يكون من السهل استخدام المصطلحات التقنية التي أنت على دراية بها دون أن تدرك أنها قد تكون مربكة للقراء الآخرين. يجب عليك أيضًا تجنب استخدام الاختصارات التي لم تشرحها مسبقًا.
إليك مثال:
أقل وضوحًا: PWAs تعتبر حقًا مستقبل تطوير المنصات المتعددة. توفرها على كل من Android و iOS يجعلها تطبيق المستقبل.
أكثر وضوحًا: تطبيقات الويب التقدمية (Progressive Web Applications - PWAs) هي حقًا مستقبل تطوير المنصات المتعددة. توفرها على كل من Android و iOS يجعل PWAs تطبيق المستقبل.
استخدام لغة بسيطة وواضحة
استخدم كلمات أقل واكتب بطريقة يمكن لأي قارئ فهم النص. تجنب الكلمات الطويلة والمعقدة. حاول دائمًا شرح المفاهيم والمصطلحات بأوضح طريقة ممكنة.
التنسيق البصري الجذاب
جدار من النص يصعب قراءته. حتى أوضح الإرشادات يمكن أن تضيع في وثيقة ذات تمثيل بصري ضعيف. يقال إن الصورة تساوي ألف كلمة. وهذا ينطبق حتى في الكتابة التقنية. ولكن ليست أي صورة تستحق أن تكون في وثيقة تقنية. قد يكون من الصعب نقل المعلومات التقنية بالنص وحده. صورة أو رسم بياني في مكانه الصحيح يمكن أن يوضح شرحك. يحب الناس أيضًا المرئيات، لذا يساعد إدراجها في الأماكن الصحيحة.
تأمل الصور أدناه:
أولًا، إليك مقتطف من مدونة بدون صور مرئية:
إليك مقتطف من نفس المدونة، ولكن مع صور مرئية:
إضافة الصور إلى مقالاتك يجعل المحتوى أكثر ارتباطًا وأسهل في الفهم. بالإضافة إلى الصور، يمكنك أيضًا استخدام صور GIF، الرموز التعبيرية، التضمينات (وسائل التواصل الاجتماعي، الأكواد)، ومقتطفات الأكواد حيثما كان ذلك ضروريًا. التنسيق المدروس، القوالب، والصور أو الرسوم البيانية ستجعل نصك أكثر فائدة لقرائك.
المراجعة الدقيقة والتدقيق
يجب أن تكون الكتابة الجيدة من أي نوع خالية من الأخطاء الإملائية والنحوية. قد تبدو هذه الأخطاء واضحة، ولكن ليس من السهل دائمًا اكتشافها (خاصة في الوثائق الطويلة). تحقق دائمًا من الإملاء والقواعد النحوية قبل النشر. هناك عدد من الأدوات المجانية مثل Grammarly و Hemingway app التي يمكنك استخدامها للتحقق من الأخطاء النحوية والإملائية. يمكنك أيضًا مشاركة مسودة مقالك مع شخص آخر لتدقيقها قبل النشر.
أين تنشر مقالاتك التقنية؟
الآن بعد أن قررت الانخراط في الكتابة التقنية، إليك بعض المنصات الجيدة حيث يمكنك البدء في نشر المحتوى التقني مجانًا. يمكنها أيضًا مساعدتك في بناء ملف أعمال (Portfolio) جذاب لأصحاب العمل المستقبليين.
Dev.to
تعتبر Dev.to مجتمعًا يضم الآلاف من التقنيين حيث يتفاعل الكتاب والقراء بشكل هادف ويتبادلون الأفكار والموارد.
Hashnode
تعتبر Hashnode منصة تدوين مميزة تقدم مزايا رائعة مثل ربط النطاق المخصص ومجتمع تفاعلي. إعداد مدونة على هذه المنصة سهل وسريع.
freeCodeCamp
تمتلك freeCodeCamp مجتمعًا ضخمًا ووصولًا واسعًا للجمهور، وهي مكان رائع لنشر مقالاتك. ومع ذلك، ستحتاج إلى التقديم للكتابة لمنشوراتهم ببعض عينات الكتابة السابقة. قد يتم قبول طلبك أو رفضه، ولكن لا تيأس. يمكنك دائمًا التقديم مرة أخرى لاحقًا مع تحسن مهاراتك، ومن يدري؟ قد يتم قبولك. إذا كتبت لهم، فسيقومون بمراجعة وتحرير مقالاتك قبل النشر، للتأكد من نشر المقال الأكثر صقلًا. كما سيشاركون مقالاتك على منصاتهم الاجتماعية لمساعدة المزيد من الناس على قراءتها.
Hackernoon
تضم Hackernoon أكثر من 7000 كاتب ويمكن أن تكون منصة رائعة لك لبدء نشر مقالاتك لأكثر من 200,000 قارئ يومي في المجتمع. تدعم Hacker Noon الكتاب من خلال تدقيق مقالاتهم قبل نشرها على المنصة، مما يساعدهم على تجنب الأخطاء الشائعة.
دورات تدريبية في الكتابة التقنية
تمامًا كما هو الحال في كل مجال آخر، هناك عمليات وقواعد وأفضل ممارسات وما إلى ذلك في الكتابة التقنية. سيساعدك أخذ دورة تدريبية في الكتابة التقنية على إرشادك خلال كل ما تحتاج إلى تعلمه، ويمكن أن يمنحك أيضًا دفعة ثقة كبيرة لبدء رحلتك في الكتابة. إليك بعض دورات الكتابة التقنية التي يمكنك الاطلاع عليها:
- دورة جوجل للكتابة التقنية (مجانية)
- دورات يوديمي للكتابة التقنية (مدفوعة)
- معسكر تدريب هاشنود للكتابة التقنية (مجاني)
منتديات ومجتمعات الكتابة التقنية
«وحدنا يمكننا أن نفعل القليل جدًا، معًا، يمكننا أن نفعل الكثير.» ~ هيلين كيلر
كونك جزءًا من مجتمع أو منتدى مع أشخاص يشاركونك نفس الشغف أمر مفيد. يمكنك الحصول على ملاحظات وتصحيحات ونصائح وحتى تعلم بعض أساليب الكتابة من الكتاب الآخرين في المجتمع. إليك بعض المجتمعات والمنتديات التي يمكنك الانضمام إليها:
كتاب تقنيون ملهمون لمتابعتهم
في رحلتي في الكتابة التقنية، صادفت وتابعت بعض الكتاب التقنيين الرائعين الذين تلهم كتاباتهم، استمراريتهم، وأسلوبهم. هؤلاء هم الكتاب الذين أعتبرهم مرشدين افتراضيين في الكتابة التقنية. أحيانًا، يشاركون نصائح في الكتابة التقنية أجدها مفيدة وقد تعلمت منها الكثير. إليك بعض هؤلاء الكتاب:
- Quincy Larson
- Edidiong Asikpo
- Catalin Pit
- Victoria Lo
- Bolaji Ayodeji
- Amruta Ranade
- Chris Bongers
- Colby Fayock
الخلاصة التقنية
لا تحتاج إلى شهادة جامعية في الكتابة التقنية لبدء إنتاج المحتوى التقني. يمكنك البدء بالكتابة على مدونتك الشخصية ومستودعات GitHub العامة بينما تبني ملف أعمالك وتكتسب الخبرة العملية. حقًا – فقط ابدأ في الكتابة. تدرب على إنشاء وثائق جديدة للبرامج أو المشاريع الموجودة. هناك عدد من مشاريع المصادر المفتوحة على GitHub يمكنك الاطلاع عليها وإضافة وثائقها. هل هناك تطبيق تحب استخدامه، ولكن وثائقه سيئة الكتابة؟ اكتب وثائقك الخاصة وشاركها عبر الإنترنت للحصول على ملاحظات. يمكنك أيضًا إعداد مدونتك بسرعة على Hashnode والبدء في الكتابة.
«تتعلم الكتابة من خلال الكتابة، ومن خلال القراءة والتفكير في كيفية قيام الكتاب بإنشاء شخصياتهم وابتكار قصصهم. إذا لم تكن قارئًا، فلا تفكر حتى في أن تكون كاتبًا.» – جين إم. أويل
الكتاب التقنيون يتعلمون دائمًا. من خلال التعمق في مجالات مواضيع جديدة وتلقي ملاحظات خارجية، لا يتوقف الكاتب الجيد أبدًا عن صقل حرفته. وبالطبع، الكتاب الجيدون هم أيضًا قراء نهمون. من خلال مراجعة الوثائق التي تحظى بقراءة أو استخدام كبير، ستتحسن كتاباتك بالتأكيد.
لا أطيق الانتظار لرؤية مقالاتك التقنية!