Apa itu dan mengapa itu perlu
Saya tidak tertarik dengan cerita yang membuat pengamat acuh tak acuh. Saya ingin orang-orang meninggalkan bioskop untuk berpikir, "Sialan, saya perlu minum." (c) Killian Murphy
Jadi apa artinya Cinema dan BDD ?! Selamat datang di kucing.
Saya akan berbicara tentang alat yang dari skrip yang ditulis dalam Gherkin (ada bahasa skrip semacam itu) membuat instruksi, atau lebih tepatnya, dokumentasi terkini (Living dokumentasi).
Agar tidak menyiksamu, aku akan segera menunjukkan hasil kerjaku (dan tidak hanya).
Saya akan memberi tahu Anda cara membuat video seperti itu dengan satu klik dari skrip yang ditulis di bawah ini. Saya perhatikan bahwa skrip dapat ditulis tidak hanya dalam bahasa Rusia, tetapi juga dalam bahasa lain.
Bukan rahasia lagi - dokumentasinya menjadi usang seiring berjalannya waktu, dan menjaganya agar tetap terbaru itu mahal, dan rusak. Dokumentasi sudah ada di sana, tetapi selalu ada sesuatu yang perlu ditambah, tangkapan layar diubah, dll. Di sini, orang-orang berjanggut datang entah dari mana dan memastikan bahwa ada cara ajaib untuk melakukan semua perkembangan Anda dengan cara yang keren (semua ini TDD / BDD /, dll yang modis,), yang dengannya semua kode Anda ditulis dengan sendirinya, tes dan dokumen itu sendiri.
Dan sekarang, didorong oleh kemalasan dan keyakinan akan masa depan yang lebih cerah, programmer 1C memutuskan untuk menerapkan konsep ini. Saya akan menunjukkan bagaimana ini bekerja dengan alat Vanessa-Automation .
Saya lupa mengatakan (sebenarnya, tentu saja saya tidak lupa, tetapi sengaja menunda :-) - alat ini untuk 1C. Tujuan saya adalah memberi tahu Anda tentang alat yang melengkapi 1C. Ya, ada alat seperti itu, bahkan lebih - mereka diposting di github dan secara aktif berkembang. Saya membiarkan diri saya melakukan penyimpangan kecil. Banyak orang tahu bahwa sekarang ada banyak kerangka kerja JavaScript, yaitu, mereka hidup di masa sekarang, tetapi untuk beberapa alasan banyak dalam hubungan 1C hidup di masa lalu. Saya ingin menunjukkan bahwa dunia 1C sedang berkembang. Ada alat Open Source normal untuk 1C.
Jadi Satu pengguna membutuhkan dokumentasi dalam bentuk dokumentasi teks (HTML, Markdown), yang lain dalam bentuk screencast, dan yang ketiga dalam bentuk video-otomatis. Dan untuk semua "Wishlist" ada solusi dalam satu botol.
HTML dan Generasi Penurunan Harga
Untuk menghasilkan HTML dan teks dalam penurunan harga, Anda perlu menginstal utilitas untuk mengambil tangkapan layar (IrfanView, nircmd atau sejenisnya). Selanjutnya, aktifkan pengaturan ini. (Layanan - Instruksi otomatis. Kami mencari bagian HTML dan Markdown). Kami mengonfigurasi folder tempat kami akan menyimpan instruksi otomatis yang dibuat secara otomatis. Contoh:
Kami meluncurkan fitur kami, jika tidak ada kesalahan, instruksi otomatis disimpan:
Pembuatan video
Tanpa kesulitan, kita bisa membuat video. Untuk melakukan ini, Anda perlu mengonfigurasi lingkungan untuk merekam video sesuai dengan instruksi dan menikmati prosesnya. Tidak perlu memotong video, rekatkan dan hamparkan suara. Ini semua dilakukan secara otomatis.
Setiap video dilengkapi dengan subtitle. Kita dapat berhenti dan membaca. Tidak sulit. Kami membuatnya senyaman mungkin bagi pengguna.
Jika Anda bosan membaca, Anda bisa membuat suara akting suara. Untuk melakukan ini, instal perpustakaan dan jalankan skrip kami. Dalam beberapa menit, video pengisi suara akan siap.
Ada fungsi melapiskan tanda air, menyoroti elemen aktif di layar (fitur ini berfungsi untuk versi platform 8.3.11 dan lebih rendah) (ya, pengguna menyukainya ketika mereka mengunyah semuanya) dan gerakan mouse ke tempat "Aksi" berlangsung.
Kustomisasi video yang fleksibel
Semuanya dimulai dengan skrip dan berakhir di atasnya. Benar juga.
Anda dapat mengkonfigurasi server CI Anda sehingga tidak menghasilkan dokumentasi untuk semua skenario, tetapi hanya untuk yang diperlukan. Untuk melakukan ini, tambahkan tag dalam skrip yang ditujukan untuk autodocs, misalnya @tree (pilihan lebih lanjut pada tag ini akan berfungsi) dan ... nikmati prosesnya.
Secara teori, ketika Anda menulis skrip besar, Anda masih harus membaginya menjadi blok logis, membuat komentar di dalamnya (bahwa bendera super penting ini perlu diatur, jika tidak tidak ada yang akan berhasil).
Gagasan video otomatis adalah menjadikan komentar ini bagian dari "cerita" yang kami tampilkan kepada pengguna.
Untuk ini, misalnya, Anda dapat mengubah teks langkah, menjadikannya lebih "manusia", karena kami menulis skrip di Gherkin, tetapi tidak selalu nyaman bagi pengguna untuk mendengarkan bahasa bisnis dan oleh karena itu ada arahan #[autodoc.text] . Bagi saya, ini adalah salah satu fitur penting dari Vanessa-Automation, karena pengguna memiliki kompetensi yang berbeda - saya mencoba menulis sejelas mungkin.
Saya ingin menggabungkan beberapa langkah dalam skrip menjadi satu (sering kali ini menyangkut beberapa operasi yang jelas). Misalnya, tambahkan data ke bagian tabel. Atau ketika satu langkah skenario bisnis (mengisi judul dokumen) terdiri dari puluhan tindakan. Kemudian arahan #[autodoc.groupsteps] . Saya ingin mencatat bahwa arahan autodock berfungsi untuk instruksi video dan html dan penurunan harga. Arahan lain dijelaskan dalam bantuan
Ketika kita menonton video yang dihasilkan, maka awalnya hanya akan ada video tanpa suara. Beberapa tangkapan layar dan teks flash, itu menjadi membosankan dan Anda berhenti menggali ke dalamnya. Ya, dan entah bagaimana sedih tanpa musik. Latar belakang video Anda dapat menempatkan musik "ringan" (atau semacam beban, keinginan apa pun) untuk membaca lebih menyenangkan. Proses pembelajaran akan berjalan lebih cepat :) Pengalaman membuat video seperti itu menunjukkan bahwa ketika musik diputar di latar belakang, video akan terasa lebih mudah. Tanpa musik - entah bagaimana kering.
Saat merekam video, kursor tidak ditampilkan dan tidak terlihat di mana kami mengklik elemen mana. Untuk melakukan ini, ada pengaturan untuk menampilkan kursor dan menyoroti elemen formulir.
Semua pengaturan di atas ditampilkan dalam video dan skrip yang dihasilkan setelah berhasilnya skrip.
Video pembaruan otomatis YouTube
Untuk perakitan malam hari (ya, kami tidak akan mengunggah video ke YouTube dengan tangan kami, bukan?), Anda dapat secara otomatis mengunggah video ke saluran youtube.
Kami menetapkan skrip pada folder fitur kami yang menentukan bahwa file telah berubah, lalu membuat video dan mengunggahnya jika perlu.
Untuk video otomatis, saya membuat aplikasi sederhana pada Golang (mengapa di sana? Saya belajar pergi dan ada masalah nyata di mana untuk menerapkannya. Jika ada sesuatu yang lain, itu akan pada sesuatu yang lain), yang mengirimkan video yang sudah selesai ke saluran youtube. Ini, tentu saja, hanyalah sebuah contoh. Video dapat ditambahkan ke wiki atau basis pengetahuan Anda, dll.
Kesimpulan
Saya membawakan Anda skenario uji di mana video dihasilkan.
Contoh, fitur.
#language: ru @tree : . : TestClient #[autodoc.ignore.scenarioslide] : . #[autodoc.text] , . "" " Habr" " ! - ..." " :-)" #[autodoc.groupsteps] . , . "" "" " Habr" "" "14,00" "" "14.08.2018" "" " !" " " " ."
Instruksi singkat tentang cara mengatur dokumentasi otomatis ada di sini .
Petunjuk tentang cara mengatur dokumentasi otomatis .
Terima kasih untuk waktu anda Tidak peduli seberapa liar kedengarannya, tetapi komunitas 1C telah melangkah maju ( dan dalam beberapa hal bahkan menyalip seseorang ), muncul alat pengujian opensource, CI - integrasi. 1C membuat API untuk produk-produknya - ini memungkinkan para penggemar untuk mengotomatiskan area yang belum terjangkau 1C, tetapi perlahan-lahan bergerak. Dan segera dunia baru yang indah menanti kita :) Saya menunggu kapan kita dapat membuat di EDT tanpa kesalahan kritis.
PS
Mendukung proyek dengan kata yang baik, seperti, kritik (obrolan proyek di Gitter ada di sini ), penulis selalu senang.
Referensi