الآن صانع أحذية مع حذاء ، أو كيف حصلنا على دليل أسلوبنا الخاص

أفترض ، أيها القراء الأعزاء ، أنه كان عليك في عملك أن تتعامل مع الوثائق الفنية ، وربما حتى مع أولئك الذين ابتكروها - مع الكتاب التقنيين. وعلى مدونتنا يمكنك مقابلة كاتب تقني من فريق Veeam.

ننتقل اليوم إلى المستوى التالي من الفهم لكيفية عمل تطوير الوثائق التقنية في Veeam Software.

KDPV خادع - هذه ليست معجزة ، ولكن نفس العمل مثل جميع الزملاء الآخرين من R & D. ومع ذلك ، فإن أولئك الذين يقومون بإنشاء أدلة لديهم كلمات سحرية لأدلةهم في إنشاء أدلة! هنا مثل هذا العودية.

اقرأ المزيد في قصة زميلتي داريا شاليجين.

مرحبًا ، اسمي داشا وأنا مدير جودة المحتوى في Veeam Software. أنا مسؤول عن جودة المحتوى الذي أنشأه قسم الكتاب الفنيين لشركتنا. من الناحية العملية ، أنا كاتب ومحرر تقني في زجاجة واحدة. تشمل مسؤولياتي ما يلي:

• أنا أدير مشاريعي الخاصة - مثل جميع الكتاب التقنيين ، فإنني أتحمل مسؤوليتي ، أي عدد من المنتجات التي أُنشئ لها وثائق وأحتفظ بها ؛
• تدريب الموظفين على مستوى المبتدئين - لقد أنشأت دورة تمهيدية "للمبتدئين" ، والتي أنفقها لشرح القواعد الأساسية لكتابة الوثائق ؛
• تقديم المشورة للموظفين على مستويات أعلى (من ذوي الخبرة والكبار) - لدي جلسات يومية مجدولة يمكن لأي عضو من أعضاء فريقنا أن يسألني خلالها عن أي سؤال يتعلق بالوثائق (سواء كانت صياغة أو بنية أو ما إلى ذلك) ؛
• — , , , .

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

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

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

وقيل:



عندما أنشأنا دليل أسلوبنا، اتخذنا كأساس 3 أدلة كبيرة، التي تتخذ عادة على عينة عند كتابة الوثائق: ( شيكاغو يدوي من نمط ، مايكروسوفت يدوي من نمط و أفضل الممارسات DITA)، ودرس على عدد من الأدلة على غرار الجهات الأخرى التي توجد مع شركات أخرى (على سبيل المثال، IBM دليل نمط ، الوثائق دليل نمط للأوبن سولاريس ، وغيرها)، أجرى دراسة أحدث الاتجاهات في مجال التوثيق - ومختلطة كل هذا مع منطقتنا أحد عشر عاما من الخبرة في Veeam البرمجيات.

أصبح:



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

مع ظهور دليل الأسلوب ، لم نسهل عملية نقل المعرفة إلى الموظفين الجدد فحسب ، بل تلقينا أيضًا المزايا التالية:

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

ميم معروف حول كيفية تغير نمط الكتابة بشكل كبير بعد أن عملت ككاتب تقني.

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

نحن نعمل حاليًا على توسيع قاعدة معارفنا. نريد إنشاء أدلة نمط منفصلة للمستندات المرجعية مثل REST API Reference و PowerShell Reference. بالنسبة لهذه المستندات ، يجب تنظيم المحتوى بطريقة خاصة ، ويجب إصلاح هذا من أجل الحفاظ على التوحيد بين المنتجات.

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

دليل أسلوب الكتابة الفنية Veeam (الإنجليزية)