50 سؤال للعمل على الوثائق

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

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

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

لماذا التوثيق مهم ، ومن يجب عليه القيام به

جعل قفص الاتهام جيدة أمر صعب. في مكان ما ، تعمل عليه مجموعة كبيرة من المحللين والكتاب والمحررين ، وفي مكان ما يكتب المطورون إلى قفص الاتهام (تم الوصف).

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

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

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

كيفية عمل وثائق جيدة

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

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

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

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

50 سؤال للعمل في قفص الاتهام

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

الأهداف

1. لمن أكتب مقالاً؟ من هو القارئ المستقبلي: المستخدم ، المسؤول ، المطور؟
2. ما المهام التي تواجهها (الوظائف التي يتعين القيام بها)؟ هل هناك وصف للشخص؟
3. ما هو مستوى تدريب هذا المستخدم؟ ماذا يعرف بالفعل؟ ما ليس واضحا له؟
4. كيف يمكنني شرح ذلك لمستخدم مبتدئ ، وفي نفس الوقت لا أغضب التفسير المتقدم للأشياء الأساسية؟
5. ما الذي يجب شرحه للمستخدم حتى يفهم المحتوى الرئيسي للمقال؟
6. ما هو القسم من الوثائق المناسب لهذه المقالة؟
7. هل يجب تكرار هذه المادة أو جزء منها في أقسام أخرى؟
8. ما هي المقالات التي يجب عليّ الارتباط بها؟
9. ربما ينبغي أن تكون مصحوبة هذه المادة من خلال تعليمات الفيديو؟

مصادر المعلومات

10. هل يواجه المستخدمون الحاليون مشاكل في موضوع المقال؟
11. كيف يفسر الدعم الآن ما يجب القيام به؟
12. هل قام قسم التسويق بكتابة مقالات وأخبار المدونة حول هذا الموضوع؟ هل يمكنهم "التجسس" على صيغتهم وبنيتهم ​​وما إلى ذلك؟
13. هل هناك أي أقسام حول هذا الموضوع على الموقع؟
14. ماذا تضمن البرنامج النصي UX ومدير المنتج؟ لماذا فعلت هذا؟
15. كيف يتم وصف هذا السؤال من قبل المنافسين؟
16. في أي مجالات لا يزال بإمكانك رؤية أفضل الممارسات؟

التحقق من المحتوى

17. هل حققت هدف المقال؟
18. هل سيكون كل شيء واضحًا للمستخدم الأكثر تقدمًا؟
19. هل سيكون كل شيء واضحًا للمستخدم المبتدئ؟
20. هل كل شيء منطقي ومتسق؟ لا يقفز والهاوية؟
21. هل تسلسل الإجراءات صحيح؟ هل سيتمكن المستخدم من تحقيق الهدف باتباع هذه التعليمات فقط؟
22. هل أخذنا في الاعتبار جميع الحالات / مسارات المستخدم؟
23. هل تندرج المقالة في القسم المختار؟

تحقق تخطيط

24. هل هناك أي ورقة غير قابلة للقراءة من النص؟ هل من الممكن استبدال الدائرة؟
25. هل هناك فقرات طويلة؟
26. هل هناك فقرات قصيرة جدًا؟
27. هل هناك قوائم طويلة جدًا؟
28. هل هناك قوائم معقدة للغاية بالنسبة للتصور (تلك التي يوجد بها أكثر من مستويين أو ثلاثة مستويات)؟
29. هل هناك ما يكفي من الصور؟
30. ليس الكثير من الصور؟ هل نوضح خطوات واضحة للغاية؟
31. إذا كان هناك مخططات ، هل هي مفهومة؟
32. الجداول ليست صعبة على الإدراك؟
33. هل تبدو الصفحة بشكل عام جيدة؟

التحرير الأدبي

34. هل تم تصميم كل شيء وفقًا للدليل؟
35. هل نمط بقية الوثائق متسق؟
36. أي اقتراحات يمكن تبسيطها؟
37. هل هناك مصطلحات معقدة تحتاج إلى توضيح؟
38. هل هناك رجال دين؟
39. هل هناك تكرار؟
40. لا شيء يضر السمع؟

التدقيق النهائي

41. هل توجد أخطاء مطبعية أو أخطاء إملائية أو علامات ترقيم؟
42. هل الواصلات والفقرات والأقسام على ما يرام؟
43. هل جميع الصور موقعة؟
44. هل تمت تسمية عناصر الواجهة بشكل صحيح؟
45. هل هناك روابط في كل مكان؟ هل يعملون وأين يذهبون؟

مباشرة بعد النشر

46. ​​هل تحتوي المقالة على أقسام "يتم سحبها" إلى مقالات أخرى؟ هل هي مزينة بوحدات الماكرو بحيث يتم تطبيق التغييرات في مقالة واحدة تلقائيًا على الآخرين؟
47. هل يجب الرجوع إلى هذه المقالة من أقسام أخرى؟ إذا كان الأمر كذلك ، فمن؟
48. هل تحتاج إلى إضافة رابط سريع لهذه المقالة في المنتج؟
49. هل يجب علي إرسال الرابط إلى الدعم أو التسويق أو الإدارات الأخرى؟
50. هل يجب علي تقديم مقالة للترجمة؟

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