تحديد مهمة الكتابة · الدرس 4

اختيار شكل الوثيقة ومحك إنجازها

4 دقائق قراءة

أهداف الدرس

  • يختار الإجراء والمرجع والشرح ومسار العطل بحسب مهمة القارئ ويحدد محك كل قطعة.
أدوات القراءة

تسمية الوثيقة «دليلًا» لا تخبر الكاتب بما يحتاجه القارئ. قد يطلب صاحب التكليف صفحة واحدة تضم طريقة بدء الاستخدام، وقائمة حقول، وتفسيرًا لقرار إداري، وحلولًا للأخطاء. هذه أنماط مختلفة من المعلومات. قبل تقرير شكل المخرج، اسأل عن قرار القراءة: هل يريد القارئ تنفيذ عمل بالترتيب، أم معرفة معنى عنصر دون تنفيذ، أم فهم سبب سياسة، أم التعافي من فشل؟ الإجراء يوجه فعلًا متتابعًا، والمرجع يساعد على البحث عن قيمة أو تعريف، والشرح يربط المفاهيم والأسباب، واستكشاف الأعطال يبدأ من عرض ملاحظ ويقود إلى اختبار وحل أو تصعيد. يمكن جمعها في مجموعة مترابطة، لكن وضعها في فقرة واحدة يضيع نقطة الدخول.

ارسم جردًا للمحتوى المطلوب مقابل شكل الوثيقة. إذا كان المطلوب تسجيل حساب لأول مرة، فالمسار الأساسي إجراء قصير يبدأ بالمتطلبات السابقة ويتبع خطوات ونتائج متوقعة. إن كانت هناك حقول كثيرة، ضع جدولًا مرجعيًا مرتبطًا بموضع إدخالها بدل تكرار شرح كل حقل في كل خطوة. إن كانت الصلاحيات تختلف، قد تحتاج صفحة مفاهيم تشرح الأدوار قبل الإجراء، على أن لا تُجبر القارئ المتمرس على إعادة قراءتها كل مرة. لا تجعل الشكل الأدبي معيارًا وحيدًا: نص جميل يخلط ما يجب فعله الآن بما يفسر خلفيته قد يبطئ المهمة أو يؤدي إلى تخطي شرط مهم.

اكتب «تعريف الإنجاز» لكل قطعة. للإجراء: يعرف القارئ متطلباته، ينفذ خطواته على النسخة المناسبة، ويرى النتيجة أو مسار الخطأ. للمرجع: يجد قيمة الحقل وشروطها دون تفسير متناقض. للشرح: يستطيع تمييز الحالة التي ينطبق فيها المفهوم من الحالة التي لا ينطبق فيها. لصفحة العطل: يبدأ من رسالة أو عرض محدد، يتأكد من سبب محتمل بخطوة آمنة، ويتوقف أو يصعّد إذا لم تنطبق الفروع. هذه ليست نسب نجاح مخترعة؛ إنها محكات مراجعة يمكن تجربتها. أضف محكًا للمصدر والإصدار، ومحكًا للغة والإتاحة حسب نوع المخرج.

راعِ حجم المهمة. قد يكون من الأنسب صفحة بدء صغيرة تصل إلى مراجع تفصيلية، لكن الإحالات يجب أن تسمّي غرض الصفحة التالية لا أن تقول «المزيد». لا تفرّع كل شرط صغير إلى ملف مستقل؛ كثرة التنقل قد تفرض على القارئ حفظ سياق طويل. ضع في الصفحة الأساسية ما يلزم لاتخاذ الفعل الآمن، وانقل ما يُستشار عند الحاجة إلى مرجع واضح. اختر الشكل بناءً على اختبارات مسار القارئ: هل يصل من نقطة البداية إلى الفعل والنتيجة دون أن يضطر إلى تخمين أين تقع المعلومة؟

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

خلاصة الدرس

يختار الإجراء والمرجع والشرح ومسار العطل بحسب مهمة القارئ ويحدد محك كل قطعة.