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