Halaman ini diterjemahkan oleh Cloud Translation API.

Proyek elektron

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.

Ringkasan proyek

Organisasi open source:: Elektron
Penulis teknis:: Tister Emas
Nama proyek:: Alur Tutorial Elektron
Durasi proyek:: Durasi standar (3 bulan)

Project description

RINGKASAN PROYEK

Electron adalah salah satu alat paling populer untuk membuat aplikasi desktop lintas platform dengan JavaScript, HTML, dan CSS. Kumpulan aplikasi yang dibangun di Electron memiliki hampir 900 entri dan daftar ini terus bertambah. Beberapa alat developer paling populer seperti Visual Studio Code, Atom, Postman, Slack, GitKraken dibangun di Electron.

Popularitas Electron terletak pada kurva belajarnya yang sederhana dan ambang masuk yang rendah - semua orang yang tahu JavaScript, HTML, tumpukan CSS dapat membangun aplikasinya sendiri. Tingkat pertumbuhan keseluruhan yang besar menentukan perlunya membuat tutorial dan panduan memulai yang mudah dipahami dan digunakan.

Tujuan proyek ini adalah untuk memberikan kepercayaan diri kepada pembuat aplikasi yang baru mengenal framework Electron dan memberi mereka pengalaman yang konsisten dan sederhana dalam mengembangkan aplikasi Electron mereka sendiri dari awal.

Masalah Project

Berikut adalah daftar masalah paling penting terkait dokumentasi tutorial Electron: 1. Titik awal yang tidak jelas dan informasi pengantar yang tidak intuitif tentang langkah-langkah pengembangan aplikasi 2. Informasi yang tersebar dan redundan terkait dengan proses pengembangan aplikasi 3. Potongan petunjuk "memulai" yang tidak teratur tanpa sumber informasi apa pun

PROPOSAL PROYEK

Sesuai dengan tujuan proyek, dan masalah yang diuraikan di atas, berikut ini adalah daftar peningkatan yang diusulkan: 1. Perbarui panduan yang ada. Agar langkah pertama lancar dan konsisten, dokumen berikut harus diperbarui secara bertahap dari yang sederhana ke yang lebih kompleks: - Lingkungan Developer - Menulis Aplikasi Elektron Pertama Anda - Menambahkan Fitur ke Aplikasi Anda (buat halaman ringkasan) - Pengemasan dan Distribusi Aplikasi 2. Mengubah struktur direktori dokumentasi. Untuk menunjukkan kepada developer baru tentang hal apa saja yang penting dalam memulai dan apa yang dapat dianggap sebagai langkah lebih lanjut, halaman dokumen harus memiliki pembagian langkah secara visual dan kontekstual untuk membuat aplikasi pertama dapat tayang secepat mungkin. Restrukturisasi juga mencakup panduan tentang kemungkinan langkah selanjutnya. 3. Mengatur dan menyatukan dokumentasi pengembangan aplikasi. Semua fitur harus memiliki serangkaian petunjuk terpadu tentang cara menginstal/mengaktifkannya, cara memulai dengan cepat, cara menggunakan aplikasi setelah peluncuran pertama, dan cara mendistribusikannya. 4. Sertakan repositori electron-api-demos dalam dokumentasi. Repositori electron-api-demos berisi kumpulan contoh yang menunjukkan cara menambahkan fitur ke aplikasi Electron Anda. Informasi ini harus disertakan dalam panduan Menambahkan Fitur ke Aplikasi Anda agar konsisten dengan strategi konten satu sumber tepercaya. 5. Mengintegrasikan contoh Electron Fiddle ke dalam dokumentasi. Langkah ini akan memudahkan developer baru melihat cara kerja potongan kode tertentu tanpa harus mengulangi langkah-langkah secara manual. Integrasinya mencakup penulisan contoh kode untuk tutorial yang diperbarui dan penambahan tombol "Luncurkan di Fiddle" ke blok kode.

Linimasa

Periode Peninjauan Pendaftaran - Kenali komunitas dan orang-orang yang bekerja sama dengan Anda. Pelajari panduan dan praktik terbaik kontribusi komunitas. Berikan kontribusi pertama. Ikatan Komunitas - Jelajahi komunitas. Memeriksa status dokumentasi Electron saat ini. Identifikasi titik lemah. Minggu 1 - Menyelaraskan dengan mentor tentang pencapaian dan hasil proyek Minggu 2 - Merevisi Lingkungan Developer dan Menulis halaman Aplikasi Elektron Pertama Anda Minggu 3 - Merevisi Arsitektur Aplikasi, Menambahkan Fitur ke Aplikasi Anda, Pengemasan Aplikasi, dan halaman distribusi. Membuat halaman ringkasan dengan daftar fitur yang dapat ditambahkan ke aplikasi Minggu 4 - Mengubah struktur direktori dokumentasi Minggu 5 - Menyiapkan template integrasi electron-api-demos ke dalam dokumentasi utama Minggu 6 - 7 - Memigrasikan repositori electron-api-demos Minggu 8 - Siapkan template yang akan menunjukkan integrasi dokumentasi utama dengan Electron Fiddle. Tulis sampel pertama. Minggu 9 - 10 - Mengintegrasikan Elektron Fiddle ke dalam dokumentasi utama Minggu 11 - Finalisasi struktur dan halaman dokumentasi utama setelah memigrasikan repositori electron-api-demos dan contoh Electron Fiddle Minggu 12 - Mengevaluasi hasil

PERINCIAN DETAIL PENCAPAIAN

PERIODE PENINJAUAN APLIKASI Bagian pertama periode ini akan difokuskan untuk memeriksa channel komunitas dan kode sumber, serta menghubungi orang yang berdedikasi terhadap project.

Bagian kedua dari periode ini akan difokuskan untuk memeriksa budaya kontribusi secara umum, memeriksa panduan kontribusi dan praktik terbaik. Inilah saatnya bagi kontribusi pertama untuk melihat cara kerja alurnya.

PENAWARAN KOMUNITAS

Kali ini akan dikhususkan untuk pemeriksaan yang lebih mendalam terhadap folder dokumentasi bersama dengan roadmap-nya. Berdasarkan informasi tersebut, titik lemah dapat diidentifikasi (misalnya bagian yang tidak lengkap atau tidak lengkap) yang dapat diperbaiki. Buat permintaan pull (jika memungkinkan) untuk mengisi kekosongan.

MINGGU 1 - MINGGU 2

Minggu pertama akan dikhususkan untuk berkomunikasi dengan mentor untuk menyelaraskan pencapaian yang diharapkan dan penyerahan tugas yang tepat waktu.

Minggu kedua adalah tentang merevisi halaman Lingkungan Developer dan Menulis Aplikasi Elektron Pertama Anda. Untuk halaman Lingkungan Developer, hal ini akan mencakup penulisan ulang ringkasan umum dan pemeriksaan teks. Untuk halaman Menulis Aplikasi Elektron Pertama Anda, halaman ini akan mencakup pembuatan halaman panduan langkah demi langkah yang konsisten dengan titik awal dan akhir yang jelas, menghapus informasi yang berlebihan (seperti dua blok kode serupa di bawah Pengembangan Elektron secara singkat dan bagian Mencoba contoh ini).

Hasil Kerja: Panduan pengantar yang telah direvisi dan mudah diikuti tentang cara memulai menggunakan aplikasi Electron.

MINGGU 3

Minggu ini akan difokuskan untuk: 1. peningkatan halaman Arsitektur Aplikasi. Ini mencakup: - penulisan ulang informasi yang ada di bagian Proses Utama dan Perender untuk membuatnya sederhana dan lebih intuitif bagi pembaca pemula - menambahkan representasi visual arsitektur, bagaimana proses terhubung, cara komunikasinya, dan perbedaan intinya. Contoh visual: Satu, Dua, Tiga (kualitas rendah). 2. penyatuan informasi tentang semua fitur yang dapat Anda tambahkan ke aplikasi Electron. Hal ini termasuk menulis ulang panduan sehingga akan memiliki serangkaian petunjuk terpadu tentang cara menginstal/mengaktifkan fitur beserta contoh cara kerja fitur tersebut. Selain itu, halaman baru (ringkasan) yang mencantumkan semua fitur yang tersedia untuk digunakan akan dibuat. Petunjuk terpadu mungkin terlihat sebagai berikut: - Ringkasan - Contoh: - Contoh kode - Contoh visual (jika memungkinkan)

penyederhanaan halaman Application Distribution. Ini mencakup: a. menggabungkan Paket Aplikasi ke dalam panduan Distribusi Aplikasi b. membagi metode distribusi menjadi otomatis dan manual c. mengambil penempaan elektron sebagai contoh distribusi otomatis d. mengambil informasi tentang asar dari halaman Pengemasan Aplikasi dan menjelaskan penyalinan file sumber serta membuat arsip asar sebagai contoh distribusi manual. #### MINGGU 4 Minggu ini akan didedikasikan untuk menyusun ulang direktori dokumentasi. Ini mencakup:

1 - membagi panduan yang ada setidaknya ke dalam tiga kategori: a. Panduan memulai b. Mempelajari dasar-dasarnya c. Langkah lanjutan

Kategori Panduan Memulai berisi tutorial dasar (penginstalan, konfigurasi, distribusi) untuk membuat serangkaian panduan yang konsisten, yang akan memungkinkan pengguna baru untuk memulai dari awal. Setiap panduan harus berisi link ke panduan sebelumnya/berikutnya dalam rangkaian ini.

Strukturnya mungkin terlihat sebagai berikut: 1. Prasyarat 2. Instal Electron 3. Buat aplikasi dasar 4. Mengemas/Mendistribusikan aplikasi

Setelah menyelesaikan bagian Panduan Memulai, pengguna akan mengetahui dasar-dasar cara kerja aplikasi Elektron dan akan memiliki aplikasi Elektron yang dapat didistribusikan dan berfungsi sepenuhnya.

Kategori Mempelajari dasar-dasar berisi panduan yang bertujuan untuk memperkuat pengetahuan tentang Elektron dan memperluas aplikasi yang dibuat di bagian Panduan Memulai. Panduan ini mencakup: - Arsitektur Aplikasi - Menambahkan Fitur ke Aplikasi Anda - Boilerplates dan CLI

Kategori Langkah lanjutan berisi panduan lebih lanjut yang ditujukan untuk mengonfigurasi dan menyempurnakan aplikasi Electron Anda: - Pengujian dan Proses Debug - Aksesibilitas - Keamanan - Update

2 - mengurangi jumlah halaman dokumentasi. Versi dokumentasi saat ini berisi konten yang tumpang tindih dan petunjuk yang tidak dikategorikan. Misalnya: - Penginstalan dan Menginstal Elektron dalam Penulisan Aplikasi Pertama Anda - Pengemasan dan Pengemasan Aplikasi ke dalam File dalam Distribusi Aplikasi - Petunjuk yang tidak dikategorikan dalam kategori Detail dan Lanjutan: Saran: pindahkan dokumen berikut ke GitHub dan kecualikan dari dokumentasi utama. Dokumen ini khusus untuk Pedoman pengembangan elektron dan repositori sumber adalah tempat pertama yang harus dicari: - Mengembangkan Elektron - Pengembangan Chromium - Pengembangan V8 - Masalah dalam Elektron - Patch dalam Elektron - Permintaan Pull - Struktur Direktori Kode Sumber - Pengujian - Gaya Coding

Ide utama dari pengurangan ini adalah menghilangkan sejumlah besar panduan yang tersedia, menggabungkan potongan-potongan teka-teki yang tersebar bersama-sama, dan memberikan versi dokumentasi Electron yang lebih terstruktur, mudah dibuka, dan ramah pengguna bagi para pendatang baru.

MINGGU 5 - 7

Minggu ke-5 akan didedikasikan untuk menyiapkan {i>template<i} (cara) bagaimana elektron-api-demos akan diintegrasikan ke dalam dokumentasi utama. Template ini mungkin terlihat seperti berikut: 1. Dalam dokumentasi utama, di bagian "Menambahkan Fitur ke Aplikasi Anda", buat kategori yang direpresentasikan dalam electron-api-demos 2. Dengan memeriksa setiap kategori, transfer contoh demo ke dokumentasi utama: - Contoh kode dapat diambil dari kode sumber atau dari deskripsi fitur terkait dalam aplikasi - Setiap contoh yang ditransfer harus diikuti dengan deskripsi terkait - Setiap contoh turunan (misalnya, Dialog error sebagai turunan dialog Sistem penggunaan) harus ditransfer di bawah induknya

CATATAN #1: ada contoh yang ada di electron-api-demos dan dalam dokumentasi utama (misalnya, pintasan keyboard, tarik lalu lepas). Dalam hal ini, contoh dari electron-api-demos harus diprioritaskan dan contoh dalam dokumentasi utama harus diabaikan.

CATATAN #2: Banyak contoh di aplikasi electron-api-demos yang memiliki pratinjau Demo Langsung dari fitur atau fungsi yang dijelaskan. Fungsi ini akan diabaikan hingga integrasi Fiddler Elektron pada Minggu ke-9-10.

Perbarui halaman yang mencantumkan semua fitur yang tersedia untuk digunakan (yang dibuat selama Minggu ke-3) dengan mematuhi hierarki contoh yang baru.

Minggu ke-6 dan ke-7 akan didedikasikan untuk mentransfer contoh electron-api-demos ke dokumentasi utama sesuai dengan {i>template<i} yang dijelaskan di atas. Sebagai langkah terakhir, repositori electron-api-demos harus dihapus atau tidak digunakan lagi.

MINGGU 8 - 10

Minggu ke-8 akan didedikasikan untuk menyiapkan template (cara) tentang bagaimana Electron Fiddle akan diintegrasikan ke dalam dokumentasi utama. Inisiatif ini telah diluncurkan (periksa detail dalam masalah #20442) oleh orang-orang Electron bersama dengan sukarelawan komunitas, tetapi perlu penyelesaian yang tepat.

Untuk melanjutkan dengan contoh Fiddle, template dasar mungkin terlihat seperti berikut: 1. Pilih contoh dari dokumentasi utama (misalnya, panduan memulai). Pada tahap ini, dokumentasi juga harus berisi contoh electron-api-demos; 2. Buat ulang contoh di Electron Fiddle (menggunakan kode contoh atau kode sumber sebagai titik awal); 3. Simpan Fiddle secara lokal ke dalam folder; 4. Pindahkan contoh ke /docs/fiddles/[CATEGORY]/[SECTION]/[DEMO]. * Daftar contoh yang telah selesai dijelaskan di bagian “Daftar Demo” dalam masalah. 5. Tambahkan tombol "Luncurkan di Fiddle" seperti yang dijelaskan dalam komentar awal pada masalah #2848.

Minggu 9 dan 10 akan didedikasikan untuk mengintegrasikan contoh electron-api-demos (yang telah dikonversi menjadi Fiddles) ke dokumentasi utama sesuai dengan template yang dijelaskan di atas.

MINGGU KE-11

Minggu ini akan sepenuhnya dikhususkan untuk finalisasi proyek penulisan setelah berhasil memigrasikan repositori electron-api-demos dan contoh Electron Fiddle. Hal ini meliputi: - memeriksa apakah semua contoh kode yang ada memiliki tombol “Luncurkan di Fiddle” - memeriksa apakah semua contoh kode yang ada berfungsi dengan baik sebagai Fiddles - memeriksa apakah dokumentasi utama tidak lagi merujuk ke repositori electron-api-demos

MINGGU KE-12

Finalisasi pekerjaan yang telah selesai. Cek penerimaan.