Cuplikan. Cara membuat proses bekerja dengan dokumentasi lebih mudah


Halo, Habr! Nama saya Pavel Lesyuk. Saya seorang penguji aplikasi seluler asli. Dalam artikel saya sebelumnya , saya memberikan daftar alat yang dapat digunakan penguji dan beberapa ahli lainnya untuk meningkatkan produktivitas pekerjaan mereka.

Dalam serangkaian artikel baru, saya ingin melihat lebih dekat beberapa alat dan menggambarkan penggunaannya dengan contoh-contoh. Artikel pertama akan dikhususkan untuk solusi paling efektif dan paling sederhana - snippet.

Cuplikan - adalah potongan teks (kode), yang disimpan untuk digunakan kembali nanti. Cuplikan datang dalam tiga bentuk: statis (teks biasa), dinamis (menggunakan variabel), dan skrip (menggunakan kode).

Pada artikel ini, kita akan melihat contoh pembuatan cuplikan statis dan dinamis saat bekerja dengan aplikasi desktop dan seluler. Ingat bahwa cuplikan adalah alat universal yang dapat digunakan oleh spesialis mana pun yang bekerja dengan informasi tekstual.

Alat Desktop


Kami akan mempertimbangkan seluruh proses menggunakan program TextExpander untuk macOS sebagai contoh . Ada versi untuk Windows, Chrome, iOS. Ini adalah alat yang paling fungsional. Biaya: $ 4,16 per bulan atau $ 3,33 per bulan untuk berlangganan tahunan. Sebagai alternatif, saya akan menyarankan mencoba PhraseExpress . Ada versi untuk macOS, Windows, iOS, Android.

MacOS memiliki penggantian otomatis bawaan. Anda dapat menemukannya di sepanjang jalan: "Pengaturan" → "Keyboard" → "Teks".


Ini hanya mendukung teks biasa, jadi hanya bisa digunakan untuk templat sederhana.

Mengisi laporan cacat


Katakanlah kita ingin mengotomatiskan proses pembuatan laporan cacat. Pertama, buat template paling lengkap untuk mengisi deskripsi di sistem pelacakan bug Jira. Kami akan mempertimbangkan fakta bahwa di masa mendatang kami ingin membuat semua kombinasi bidang yang paling sering digunakan untuk mengisi deskripsi laporan. Mari kita mulai.

Membuat grup cuplikan


Pertama, buat grup cuplikan dan beri nama.

Menetapkan nama dan singkatan


Sekarang Anda perlu membuat cuplikan baru, berikan nama dan singkatan. Identifier nama yang dengannya Anda dapat dengan cepat menentukan apa yang terkandung dalam cuplikan dan menemukannya jika perlu. Singkatan - urutan karakter, setelah memasukkan isi cuplikan akan dimasukkan.

Berikut adalah beberapa sifat akronim yang baik:

  1. . , ( ). «report», . , , . , . , «,report» . — .
  2. . . , . , «,bg», «,bg2», «2» .
  3. . , . , «Bug report» «,report» «,bg».
  4. . .

Dalam kebanyakan kasus, saya lebih suka menggunakan nama dan singkatan dalam bahasa Inggris. Kami akan memanggil cuplikan pertama "Lingkungan, prakondisi, langkah, hasil aktual dan yang diharapkan" (ingat, kami ingin membuat beberapa kombinasi lebih dari parameter ini, jadi saya pikir nama ini yang paling cocok). Singkatannya adalah ", epsae", yang sesuai dengan huruf pertama dari kata-kata dalam nama. Anda juga dapat mengkonfigurasi sensitivitas huruf.

Isi Cuplikan


Isi snippet dengan konten untuk menggambarkan laporan.

Kami telah membuat cuplikan statis. Karakter "*" dan "#" adalah sintaks pemformatan di Jira (masing-masing daftar tebal dan bernomor). Mari kita lihat bagaimana cara kerja sisipan.


Jauh lebih baik daripada memasukkan semua ini secara manual atau mencari templat yang diinginkan dalam catatan, bukan? Di pengaturan Anda dapat mengatur opsi penyisipan snippet. Penyisipan dapat terjadi segera setelah input atau setelah menekan tombol batas.

Dengan cara yang sama, kita bisa membuat templat untuk semua kombinasi bidang yang digunakan dalam deskripsi laporan cacat. Anda dapat membuat set templat yang paling sering kami gunakan.

Sebagai contoh, saya memiliki set ini sebagai berikut:

  • Prasyarat, langkah, hasil aktual dan yang diharapkan
  • Prasyarat, hasil aktual dan yang diharapkan
  • Langkah-langkah, hasil aktual dan yang diharapkan
  • Hasil aktual dan yang diharapkan

Menggunakan elemen dinamis


Mari kita lihat beberapa contoh lagi.

Misalnya, saya perlu dengan cepat menyematkan tautan dalam teks saat menyiapkan laporan. Saat menggunakan alat bawaan di Jira, tampilannya seperti ini:


Sepertinya tidak buruk, kita bisa langsung mulai mengetik. Tetapi bagaimana jika, alih-alih example.com, saya ingin menempelkan tautan yang sudah disalin dari clipboard? Untuk melakukan ini, kita perlu kemampuan untuk membuat konten dinamis di dalam cuplikan.

Menggunakan elemen dinamis, kami menempelkan konten yang disalin ke clipboard dan menempatkan kursor pada posisi yang kami butuhkan. Mari kita lihat bagaimana cara kerja sisipan.


Sekarang kita akan memperbaiki templat pertama kita. Misalkan Anda adalah penguji seluler, Anda memiliki armada perangkat seluler, yang sebagian ditugaskan untuk Anda. Anda paling sering menguji pada perangkat ini, dan Anda ingin memiliki daftar mereka saat menyiapkan laporan cacat.

Pertama, buat daftar perangkat. Kami melakukan ini menggunakan item opsional untuk memilih.

Selanjutnya, buat daftar host yang kami uji. Tambahkan potongan baru ke grup kami dan gunakan lagi elemen opsional.

Baik! Sekarang mari kita beralih ke cuplikan utama kami dan memperkaya dengan konten. Kami menambahkan penyisipan elemen opsional dari snippet lain dan mengatur posisi kursor sehingga Anda dapat segera mulai memasukkan teks. Mari kita lihat cara kerja potongan lanjutan kami.




Saat menyisipkan elemen dinamis yang mengharapkan beberapa tindakan dari pengguna (mengisi, memilih, dll.), Jendela terpisah akan terbuka di mana tindakan yang sesuai perlu dilakukan pada elemen-elemen ini.

Membuat templat catatan


Contoh lain: membuat templat untuk struktur catatan kerja. Saya menyimpan catatan dengan dukungan penurunan harga untuk pembuatan aplikasi seluler dengan struktur tertentu dan menggunakan cuplikan untuk membuatnya dengan cepat. Di bawah ini adalah contoh dari memasukkan template yang sudah jadi ke dalam catatan.




Mengisi formulir tes


Saat bekerja dengan aplikasi web / desktop, Anda dapat menggunakan potongan untuk mengisi formulir dengan data.

Dengan mensimulasikan menekan tombol Tab, transisi antar bidang terjadi secara otomatis.


Pelaporan


Pertimbangkan untuk membuat laporan pengujian. Misalkan sekali seminggu kita menulis laporan tentang proyek-proyek baru dalam aplikasi seluler.

Kami menggunakan elemen dinamis, teks dan gambar yang diformat.

Sebagai hasilnya, kami mendapatkan struktur laporan yang siap pakai, yang dapat dengan cepat diisi dengan nilai yang diperlukan dan mengirim surat.


Alat OS Seluler


Android


Di Android, Anda dapat menggunakan Texpand atau Gboard . Sayangnya, di kedua aplikasi tidak ada kemungkinan sinkronisasi antar perangkat.

Gboard hanya mendukung teks biasa. Sebenarnya, ini adalah clipboard yang diperluas di mana Anda dapat menyematkan beberapa fragmen.


Di Texpand peluangnya lebih luas. Versi gratis memiliki dukungan untuk 10 snippet, tanggal dan waktu dinamis, menempel dari clipboard dan mengatur posisi kursor. Anda juga dapat mencadangkan dan mengimpor cuplikan ke perangkat lain.


iOS


IOS memiliki built-in auto-replace, hanya mendukung teks biasa.

Ada juga versi TextExpander dan PhraseExpress untuk iOS.

Di TextExpander, semua cuplikan disinkronkan antara versi desktop dan seluler. Ada beberapa batasan dalam versi seluler dibandingkan dengan versi desktop:

  1. Cuplikan dibuka saat mencetak hanya dengan keyboard TextExpander aktif (keyboard dilengkapi dengan aplikasi, yang dapat diaktifkan dalam pengaturan iOS).
  2. Interaksi dengan elemen dinamis (pengisian, pemilihan, dll.) Hanya berfungsi di aplikasi itu sendiri, di segmen "Catatan". Dari sana, cuplikan yang telah selesai dapat disalin atau dikirim melalui menu berbagi.
  3. Cuplikan skrip tidak berfungsi (tidak dipertimbangkan dalam artikel ini).


Anda dapat menambahkan cuplikan ke favorit Anda untuk akses cepat dari keyboard.

Di bawah ini adalah contoh bekerja dengan cuplikan dinamis.


Kesimpulan


Kami memeriksa karya potongan statis dan dinamis menggunakan contoh membuat dokumentasi uji. Mereka juga dapat digunakan untuk membuat berbagai jenis surat (milis berulang, tawaran pekerjaan, dll.), Struktur dokumen dan catatan, pembuatan kode, dan banyak lagi .

Terima kasih telah membaca artikel sampai akhir. Saya harap informasi yang terkandung di dalamnya akan bermanfaat bagi Anda, dan Anda dapat menghemat waktu dengan menggunakannya dalam praktik. Jika Anda memiliki pertanyaan tentang artikel ini - saya akan dengan senang hati menjawabnya. Pada artikel berikutnya, saya berencana untuk menulis tentang menggunakan cuplikan skrip. Sementara itu, saya mengusulkan untuk berlangganan saluran Telegram saya , tempat saya menerbitkan semua informasi lain tentang topik pengujian.

Source: https://habr.com/ru/post/undefined/


All Articles