Panduan berikut akan membantu Anda menyajikan konten dalam bentuk tutorial, sehingga pengguna dapat memahami project Anda secara efektif.
Fitur Cloud Shell
- Tata letak unik: Tutorial ditampilkan dalam panel samping di sisi kanan Konsol Google Cloud.
- Navigasi: Pengguna dapat melanjutkan tutorial menggunakan tombol Next dan Previous di setiap langkah. Mereka juga dapat menutup tutorial dan melanjutkan dari bagian terakhir yang mereka tinggalkan.
- Kode to go: Cuplikan kode dapat disalin langsung ke Cloud Shell.
Sesi Cloud Shell Editor dengan panel tutorial terbuka. Pengguna dapat menyalin kode langsung ke Cloud Shell dengan mengklik tombol, dan dapat berpindah antar-halaman dengan tombol Next dan Previous.
Gaya penulisan
- Usahakan tetap ringan: Tutorial harus informatif dan memiliki nada yang membantu, tetapi tidak terlalu formal.
- Anda, pengguna: Gunakan sebutan orang kedua (gunakan: Anda, Anda; jangan gunakan: kami, saya, kami, dan seterusnya)
- Jelaskan sebab dan akibat: Saat meminta pengguna untuk melakukan suatu langkah, jelaskan alasan di balik tindakan tersebut dan hasil yang diharapkan.
- Miliki tujuan yang terfokus: Sebelum menulis konten untuk tutorial, tetapkan tujuan yang jelas yang Anda inginkan untuk dicapai pengguna. Buat tutorial dengan mempertimbangkan sasaran ini.
| Asli | Direvisi | Penyempurnaan |
| Di halaman berikutnya, Anda akan mempelajari cara membuat tutorial baru. | Lanjutkan ke langkah berikutnya untuk mulai menyiapkan tutorial. | Fokus pada pengguna; penggunaan kalimat aktif
Penggunaan bahasa yang santai |
| Jalankan perintah ini:
``` gcloud projects list --format="table[box,title=Projects](name, projectId)" ``` |
Untuk menampilkan daftar tabulasi yang berisi semua project Anda beserta nomor ID-nya, yang berjudul 'Projects', jalankan perintah berikut: ``` gcloud projects list --format="table[box,title=Projects](name, projectId)" ``` | Penjelasan alasan di awal untuk menetapkan ekspektasi tentang output |
Let's get started!
|
Let's get started!
Panduan ini akan menunjukkan kepada Anda cara membuat tutorial interaktif sendiri. Bagian ini juga akan memandu Anda untuk membuat tombol yang dapat digunakan pengguna untuk meluncurkan tutorial yang telah diselesaikan. |
Petunjuk yang jelas tentang pelajaran yang dibahas dalam tutorial
Pastikan untuk menjaga fokus ini saat menulis konten. |
Praktik terbaik
Jaga agar tetap singkat: Batasan ruang unik di panel tutorial berarti bahwa sejumlah kecil informasi dapat disajikan kepada pengguna pada satu waktu. Hindari teks berukuran besar yang sulit dipindai dan memerlukan scroll vertikal; pilih informasi yang ditampilkan dalam potongan berukuran kecil.
Usahakan tidak lebih dari 5 langkah dan 3 cuplikan kode per halaman.
Idealnya, paragraf harus terdiri dari 5 baris atau kurang dan harus berkaitan dengan konsep tunggal.
Jika halaman harus panjang, usahakan agar panjangnya maksimum dua kali panjang panel.
Blok kode dan terminal harus cukup kecil untuk dibaca:
- Targetkan untuk maksimal 10 baris.
- Usahakan panjang 80 karakter atau kurang per baris untuk mengurangi scroll horizontal.
- Hindari blok kode multi-perintah untuk mencegah pengguna melakukan eksekusi penyalinan massal.
Halaman pengantar: Mulai tutorial dengan pengenalan.
- Tetapkan ekspektasi: Jelaskan secara singkat bagaimana pengguna akan mendapatkan keuntungan jika menyelesaikan tutorial ini.
- Perkiraan komitmen waktu: Perkirakan kasar waktu yang diperkirakan pengguna untuk menonton tutorial. Usahakan untuk membuat tutorial yang dapat diselesaikan dalam waktu kurang dari 15 menit. Jika tutorial Anda lebih panjang (atau terdiri dari lebih dari 15 halaman dengan kata-kata padat), pertimbangkan untuk membaginya menjadi serangkaian tutorial yang lebih kecil.
- Bersikap terbuka: Nyatakan dengan jelas resource atau akses prasyarat yang mungkin perlu disiapkan pengguna untuk mengikuti tutorial tanpa gangguan.
Contoh ## Mari kita mulai.
Buat pengguna Anda siap dan menjalankan project Anda secara cepat dengan menyertakan tutorial interaktif.
Panduan ini akan menunjukkan cara membuat tutorial interaktif Anda sendiri (seperti yang satu ini). Bagian ini juga akan memandu Anda membuat tombol yang dapat digunakan pengguna untuk meluncurkan tutorial yang telah selesai.
**Waktu penyelesaian**: Sekitar 10 menit
**Prasyarat**: Akun Penagihan Cloud
Klik tombol **Continue** untuk melanjutkan ke langkah berikutnya.
Halaman latar belakang
- Tetapkan suasana: Sebaiknya berikan konteks, misalnya saat menulis tutorial. Hal ini mungkin berarti memberikan ringkasan singkat tentang produk atau menjalankannya dengan cepat melalui fitur UI yang penting.
Contoh ## Apa itu Cloud Shell?
Sebelum memulai, mari kita bahas secara singkat apa yang dapat dilakukan Cloud Shell.
Cloud Shell adalah Mesin Virtual yang dihosting pribadi dan dilengkapi dengan alat developer untuk produk Google Cloud. Lingkungan shell interaktif ini dilengkapi dengan editor kode bawaan, penyimpanan persistent disk, dan fungsi pratinjau web. Untuk menggunakan akses command line saja, buka [console.cloud.google.com/cloudshell](https://console.cloud.google.com/cloudshell).
Anda dapat mengarahkan pengguna ke Cloud Shell untuk membantu mereka memulai project dengan cepat; memberi mereka kesempatan untuk menjalankan kasus penggunaan dan memahami fungsionalitas project Anda.
Lanjutkan ke langkah berikutnya untuk mulai menyiapkan tutorial.
Contoh Dasar:
- Halo Dunia: Contoh pertama yang Anda berikan harus cukup sederhana bagi pengguna untuk melakukan pengujian tanpa banyak penjelasan. Nama ini harus setara dengan Halo Dunia Anda. Gunakan contoh ini sebagai dasar untuk terus membangun contoh konsep melalui tutorial.
Contoh ## Tutorial dalam konteks
Apa yang Anda lihat sekarang adalah tutorial dalam konteks.
Konten ditampilkan bersama dengan lingkungan Cloud Shell tempat Anda dapat menjalankan langkah-langkah tutorial. Membuka lingkungan tutorial dan pengembangan di tempat yang sama akan mempermudah pengguna untuk mulai menggunakan project Anda melalui pengalaman satu layar yang mudah digunakan.
Coba jalankan perintah sekarang:
{i>```bash<i}
echo "Hello Cloud Shell"
```
**Tips**: Klik tombol salin di sisi kotak kode untuk menempelkan perintah di terminal Cloud Shell untuk menjalankannya.
Berikutnya, Anda akan menulis dan meluncurkan tutorial dasar.
Konten Tutorial
- Format dengan hati-hati: Format teks (tebal, miring, dll.) mengganggu; gunakan hanya jika diperlukan dan demi keuntungan Anda (untuk peringatan, pembelajaran penting, dll.).
- Tata bahasa yang konsisten: Gunakan frasa imperatif saat menjelaskan tindakan pengguna dan pastikan untuk mengakhiri kalimat dengan titik.
- Lihat link: Jika penting untuk konteks, sertakan link tambahan ([teks link](URL link)) agar pengguna dapat melakukan riset sendiri.
- Pilih sorotan di atas screenshot: Spotlighting, tindakan yang menyoroti lokasi elemen UI di konsol Google Cloud, menunjukkan posisi sehingga pengguna dapat mengidentifikasi elemen tanpa mencari gambar.
- Tampilan alternatif: Jika memungkinkan, sediakan link ke konten tutorial yang ditawarkan sebagai konten statis; ini memberi pengguna kebebasan untuk memilih cara menggunakan informasi yang diberikan.
- Tips yang dianjurkan: Jika memungkinkan, tambahkan tips (disebut dengan "**Tip:**") untuk memberikan praktik terbaik dan solusi yang lebih intuitif kepada pengguna.
Contoh ## Menulis dalam Markdown
Untuk menulis tutorial, gunakan [Markdown](https://en.wikipedia.org/wiki/Markdown) dan ikuti panduan berikut:
### Edit judul
Ubah judul tutorial ini ('# Pengantar penulisan tutorial di Cloud Shell') dengan mengubahnya menjadi:
```
# Ajari saya menulis tutorial
```
### Tambahkan langkah baru
Selanjutnya, tambahkan langkah tepat setelah judul seperti ini:
```
## Langkah 1
Ini adalah langkah baru yang baru saja saya tambahkan.
```
Setiap 'langkah' tutorial ditampilkan di satu halaman.
**Tips**: Untuk berpindah langkah-langkah, pengguna akan menggunakan tombol 'Kembali' dan 'Lanjutkan/Maju'.
Ringkasan
- Selamat: Pastikan Anda menambahkan ikon piala (<walkthrough-conclusion-trophy></walkthrough-conclusion-trophy>) untuk menghargai pengguna yang meluangkan waktu untuk menyelesaikan tutorial.
- Rangkuman: Rangkum pelajaran penting yang Anda ingin pengguna pahami dari tutorial.
- Langkah selanjutnya: Bantu pengguna di sepanjang perjalanan mereka dengan memberikan langkah-langkah berikutnya - rekomendasi ini mungkin berupa bacaan yang direkomendasikan, referensi tambahan, atau bahkan tutorial lainnya.
- Perhatikan pengguna: Anjurkan mereka untuk membersihkan semua resource pengujian yang mereka buat untuk tujuan tutorial guna menghindari biaya penagihan yang tidak diinginkan.
Contoh ## Selamat
<walkthrough-conclusion-trophy></walkthrough-conclusion-trophy>
Anda sudah siap!
Kini Anda dapat meminta pengguna meluncurkan tutorial di Cloud Shell dan meminta mereka mulai menggunakan project dengan mudah.
Untuk mengetahui daftar lengkap alat penulisan tutorial Cloud Shell, lihat [Referensi Tutorial Markdown](https://cloud.google.com/shell/docs/tutorial-markdown-reference).
**Jangan lupa membersihkan semuanya**: Jika Anda membuat project pengujian, pastikan untuk menghapusnya agar tidak dikenai biaya. Gunakan `gcloud projects delete <PROJECT-ID>`.