ما هو ولماذا هو ضروري

لست مهتمًا بالقصص التي تترك المشاهد غير مبالٍ. أريد من الأشخاص الذين يغادرون السينما أن يفكروا ، "اللعنة ، أنا بحاجة إلى شراب". (ج) كيليان ميرفي
فماذا يعني ذلك السينما و BDD ؟! مرحبا بكم في القطط.
سأتحدث عن أداة من نص مكتوب بلغة غيركين (توجد لغة برمجة نصية كهذه) تقدم تعليمات ، أو بالأحرى ، وثائق حديثة (وثائق حية).
لكي لا أعذبك ، سأعرض على الفور نتيجة عملي (وليس فقط).
سأخبرك بكيفية إنشاء مثل هذا الفيديو بنقرة واحدة من النص المكتوب أدناه. ألاحظ أن النصوص يمكن كتابتها ليس فقط باللغة الروسية ، ولكن أيضًا بلغات أخرى.
إنه ليس سراً - تصبح الوثائق عفا عليها الزمن بمرور الوقت ، وإبقائها محدثة مكلفة ، وتتعطل. الوثائق موجودة بالفعل ، ولكن باستمرار يجب استكمال شيء ما ، وتغيير لقطات الشاشة ، وما إلى ذلك. هنا ، يأتي الرجال الملتحيون من العدم ويؤكدون أن هناك طريقة سحرية للقيام بكل تطويرك بطريقة باردة (كل هذه TDD / BDD / الخاصة بك ، وما إلى ذلك) ، والتي تتم كتابة جميع التعليمات البرمجية بها بنفسها ، والاختبارات والوثائق نفسها.
والآن ، مدفوعًا بالكسل والإيمان بمستقبل أكثر إشراقًا ، قرر مبرمجو 1C تطبيق هذا المفهوم. سأوضح كيف يعمل هذا مع أداة Vanessa-Automation .
لقد نسيت أن أقول (في الواقع ، بالطبع لم أنسى ، ولكن تأخرت عمداً :-) - هذه الأداة هي لـ 1C. هدفي هو أن أخبرك عن أداة تكمل 1C. نعم ، هناك مثل هذه الأدوات ، أكثر من ذلك - يتم نشرها على github وهي تتطور بنشاط. أسمح لنفسي بحفر صغير. يعرف الكثير من الناس أنه يوجد الآن العديد من أطر JavaScript ، أي أنهم يعيشون في الوقت الحاضر ، ولكن لسبب ما يعيش العديد في علاقة 1C في الماضي. أريد أن أبين أن عالم 1C يتطور. هناك أدوات عادية مفتوحة المصدر لـ 1C.
لذا يحتاج أحد المستخدمين إلى وثائق في شكل توثيق نصي (HTML ، Markdown) ، وآخر في شكل تسجيل صوتي ، والثالث في شكل فيديو تلقائي. وللجميع "قائمة الرغبات" هناك حل في زجاجة واحدة.
إنشاء HTML و Markdown
من أجل إنشاء HTML ونص في الترقيم ، تحتاج إلى تثبيت أداة لالتقاط لقطات الشاشة (IrfanView أو nircmd أو ما شابه). بعد ذلك ، قم بتمكين هذا الإعداد. (خدمة - تعليمات تلقائية. نبحث عن قسم HTML و Markdown). نقوم بتكوين المجلد الذي سنحفظ فيه الإرشادات التلقائية التي تم إنشاؤها تلقائيًا. مثال:

نطلق ميزة لدينا ، إذا لم تكن هناك أخطاء ، يتم حفظ التعليمات التلقائية:

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

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

هناك وظيفة لتركيب علامة مائية ، وتسليط الضوء على العنصر النشط على الشاشة (تعمل هذه الميزة مع إصدارات النظام الأساسي 8.3.11 والإصدارات الأقل) (نعم ، يحبها المستخدمون عند مضغ كل شيء) وحركات الماوس إلى المكان الذي يحدث فيه "الإجراء".
تخصيص الفيديو المرن
يبدأ كل شيء بالنص وينتهي عليه. هذا صحيح.
يمكنك تكوين خادم CI الخاص بك بحيث لا يقوم بإنشاء وثائق لجميع السيناريوهات ، ولكن فقط للسيناريوهات الضرورية. للقيام بذلك ، قم بإضافة علامة في البرامج النصية المخصصة للمحررات الآلية ، على سبيل المثال @tree
( @tree
المزيد من التحديد على هذه العلامة) و ... استمتع بالعملية.
من الناحية النظرية ، عندما تكتب نصًا كبيرًا ، لا يزال عليك تقسيمه إلى كتل منطقية ، وإبداء التعليقات فيه (يحتاج هذا العلم المهم للغاية إلى تعيين ، وإلا لن ينجح أي شيء).
إن فكرة الفيديو التلقائي هي جعل هذه التعليقات جزءًا من "القصة" التي نعرضها للمستخدم.
لهذا ، على سبيل المثال ، يمكنك تغيير نص الخطوة ، وجعلها أكثر "بشرية" ، حيث أننا نكتب نصًا برمجيًا في غيركين ، ولكن ليس من المناسب دائمًا للمستخدمين الاستماع إلى لغة الأعمال ، وبالتالي هناك توجيه #[autodoc.text]
. بالنسبة لي ، هذه إحدى الميزات المهمة لـ Vanessa-Automation ، نظرًا لأن المستخدمين لديهم كفاءات مختلفة - أحاول الكتابة بأكبر قدر ممكن من الوضوح.
أود دمج بعض الخطوات في البرنامج النصي في خطوة واحدة (غالبًا ما يتعلق هذا ببعض العمليات الواضحة). على سبيل المثال ، أضف البيانات إلى القسم المجدول. أو عندما تتكون خطوة واحدة من سيناريو الأعمال (ملء عناوين المستند) من عشرات الإجراءات. ثم يتم استخدام التوجيه #[autodoc.groupsteps]
. أريد أن أشير إلى أن توجيهات autodock تعمل لكل من تعليمات الفيديو و html و markdown. يتم وصف توجيهات أخرى
للمشروع.
عندما نشاهد الفيديو الذي تم إنشاؤه ، في البداية سيكون هناك فقط فيديو بدون صوت. بعض لقطات الشاشة وفلاش النص ، تصبح مملة وتتوقف عن الخوض فيها. نعم ، وبطريقة ما حزينة بدون موسيقى. في خلفية الفيديو ، يمكنك وضع موسيقى "خفيفة" (أو نوع من الثقل ، أي نزوة) لقراءة المزيد من المرح. ستسير عملية التعلم بشكل أسرع :) أظهرت تجربة إنشاء مقاطع الفيديو هذه أنه عند تشغيل الموسيقى في الخلفية ، يُنظر إلى الفيديو بسهولة أكبر. بدون موسيقى - تجف بطريقة أو بأخرى.
عند تسجيل مقطع فيديو ، لا يتم عرض المؤشر ولا يكون مرئيًا حيث ننقر على أي عنصر. للقيام بذلك ، هناك إعداد لعرض المؤشر وإبراز عنصر النموذج.
يتم عرض جميع الإعدادات المذكورة أعلاه في الفيديو وفي البرنامج النصي التي تم إنشاؤها بعد مرور البرنامج النصي بنجاح.
فيديو يوتيوب للتحديث التلقائي
للتجميع الليلي (حسنًا ، لن نقوم بتحميل مقاطع الفيديو على YouTube بأيدينا ، أليس كذلك؟) ، يمكنك تحميل مقاطع الفيديو تلقائيًا إلى قناة youtube.
قمنا بتعيين برنامج نصي على مجلد الميزات الخاص بنا والذي يحدد أن الملف قد تغير ، ثم نقوم بإنشاء الفيديو وتحميله عند الضرورة.
بالنسبة للفيديو التلقائي ، قمت بعمل تطبيق بسيط على Golang
(لماذا؟ لقد درست الذهاب وكانت هناك مشكلة حقيقية في مكان تطبيقه. إذا كان هناك شيء آخر ، فسيكون على شيء آخر) ، والذي يرسل الفيديو النهائي إلى قناة youtube. هذا ، بالطبع ، مجرد مثال. يمكن إضافة مقاطع الفيديو إلى موقع wiki أو قاعدة المعرفة ، وما إلى ذلك.
الخلاصة
أقدم لك سيناريو اختبار يتم فيه إنشاء الفيديو.
مثال الميزة.
#language: ru @tree : . : TestClient #[autodoc.ignore.scenarioslide] : . #[autodoc.text] , . "" " Habr" " ! - ..." " :-)" #[autodoc.groupsteps] . , . "" "" " Habr" "" "14,00" "" "14.08.2018" "" " !" " " " ."
توجد تعليمات مختصرة حول كيفية إعداد التوثيق التلقائي هنا .
إرشادات حول كيفية إعداد التوثيق التلقائي .
شكرا لك على وقتك. مهما بدا الأمر جامحًا ، لكن مجتمع 1C قد تقدم للأمام ( وفي بعض النواحي تفوقت على شخص ما ) ، ظهرت أدوات اختبار مفتوحة المصدر ، CI - التكامل. تصنع 1C واجهة برمجة تطبيقات لمنتجاتها - وهذا يسمح للهواة بأتمتة المناطق التي لم تصل إليها 1C بعد ، ولكنها تتحرك ببطء. وسرعان ما ينتظرنا عالم رائع جديد :) أنتظر متى يمكننا إنشاء في EDT دون أخطاء فادحة.
ملاحظة
دعم المشروع بكلمة لطيفة ، مثل النقد (دردشة المشروع في Gitter هنا ) ، يسعد المؤلفون دائمًا.
المراجع