كيفية تنفيذ الوثائق الفنية

بواسطة ClickHelp - أداة التأليف المساعدة المهنية

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

اشخاص

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

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

معالجة

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

شكل

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

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

إذا كنت ترغب في معرفة المزيد حول فوائد مستنداتك التي يتم نشرها عبر الإنترنت ، فراجع هذا المنشور المسمى "18 مليار سبب".

أدوات

بمجرد معرفة تنسيق الوثائق وتجميع الفريق ، حان الوقت للبحث عن الأدوات المناسبة.

لحسن الحظ ، هناك الكثير من الحلول الجاهزة ، مثل: HAT ، أو المساعدة في أدوات التأليف. هذه أدوات خاصة تم تطويرها للكتاب التقنيين ، وهي أكثر بكثير من مجرد برامج لتحرير النصوص. تعتبر معظم الحلول الحديثة للكتاب التقنيين مرنة جدًا مما يعني أنك ستتمكن من ضبط الأداة وفقًا لاحتياجاتك المحددة.

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

خاتمة

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

حظا سعيدا مع مهنتك الكتابة الفنية!
فريق ClickHelp
تأليف واستضافة وتقديم الوثائق عبر الأنظمة الأساسية والأجهزة

نشرت أصلا في clickhelp.co.