Trang này được dịch bởi Cloud Translation API.

Dự án điện tử

Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.

Tóm tắt dự án

Tổ chức nguồn mở:: Điện tử
Người viết nội dung kỹ thuật:: Màu vàng
Tên dự án:: Quy trình hướng dẫn về điện tử
Thời lượng dự án:: Thời gian tiêu chuẩn (3 tháng)

Mô tả dự án

TÓM TẮT DỰ ÁN

electron là một trong những công cụ phổ biến nhất để xây dựng ứng dụng trên máy tính để bàn đa nền tảng bằng JavaScript, HTML và CSS. Một bộ sưu tập ứng dụng được tạo trên Electronic có gần 900 mục nhập và danh sách này tăng liên tục. Một số công cụ phổ biến nhất cho nhà phát triển như Visual Studio Code, Atom, Postman, Slack, GitKraken được xây dựng trên electron.

Sự phổ biến của electron nằm ở công việc học tập đơn giản và ngưỡng gia nhập thấp - tất cả những ai biết ngăn xếp JavaScript, HTML, CSS đều có thể tạo ứng dụng của riêng mình. Với tốc độ tăng trưởng tổng thể rất lớn, bạn cần phải tạo các video hướng dẫn và hướng dẫn bắt đầu dễ nắm bắt cũng như dễ sử dụng.

Mục tiêu của dự án là mang lại niềm tin cho những người tạo ứng dụng mới sử dụng khung electron, đồng thời mang lại cho họ trải nghiệm nhất quán và đơn giản trong việc phát triển các ứng dụng electron của riêng họ ngay từ đầu.

Vấn đề về dự án

Sau đây là danh sách các vấn đề quan trọng nhất liên quan đến tài liệu về hướng dẫn về electron: 1. Điểm xuất phát không rõ ràng và thông tin giới thiệu không trực quan về các bước phát triển ứng dụng 2. Thông tin rải rác và dư thừa liên quan đến quá trình phát triển ứng dụng. Những chi tiết hướng dẫn cách "bắt đầu" thiếu ngăn nắp mà không có một nguồn thông tin chính xác duy nhất

ĐỀ XUẤT DỰ ÁN

Theo mục tiêu của dự án và các vấn đề đã nêu ở trên, sau đây là danh sách các tính năng nâng cao được đề xuất: 1. Cập nhật các hướng dẫn hiện có. Để thực hiện các bước đầu tiên mượt mà và nhất quán, bạn nên cập nhật dần các tài liệu sau đây và chuyển dần từ đơn giản sang phức tạp hơn: – Môi trường nhà phát triển – Viết ứng dụng điện tử đầu tiên – Thêm tính năng vào ứng dụng (tạo trang tóm tắt) – Đóng gói và phân phối ứng dụng 2. Điều chỉnh cấu trúc thư mục tài liệu. Nhằm giúp nhà phát triển mới biết được những yếu tố cần thiết để bắt đầu và những bước tiếp theo, trang tài liệu phải có phần phân chia các bước theo bối cảnh và hình ảnh để đảm bảo ứng dụng đầu tiên phát hành được nhanh nhất có thể. Việc tái cấu trúc cũng bao gồm hướng dẫn về các bước tiếp theo có thể thực hiện. 3. Sắp xếp và hợp nhất tài liệu phát triển ứng dụng. Tất cả các tính năng cần phải có một bộ hướng dẫn thống nhất về cách cài đặt/bật ứng dụng, cách bắt đầu nhanh, cách làm việc với một ứng dụng sau lần khởi chạy đầu tiên và cách phân phối ứng dụng. 4. Thêm kho lưu trữ electron-api-demos vào tài liệu. Kho lưu trữ electron-api-demos chứa một tập hợp các ví dụ cho thấy cách thêm tính năng vào ứng dụng electron của bạn. Thông tin này phải được đưa vào hướng dẫn Thêm tính năng vào ứng dụng của bạn để nhất quán với một nguồn chiến lược nội dung đáng tin cậy duy nhất. 5. Tích hợp các ví dụ về electron Fiddle vào tài liệu. Bước này sẽ giúp các nhà phát triển mới dễ dàng xem cách hoạt động của một đoạn mã cụ thể mà không phải lặp lại các bước theo cách thủ công. Nội dung tích hợp bao gồm việc viết mã mẫu cho các hướng dẫn đã cập nhật và thêm nút "Launch in Fiddle" vào các khối mã.

Diễn biến chính

Giai đoạn xem xét đơn đăng ký – Làm quen với cộng đồng và những người mà bạn có thể làm việc cùng. Tìm hiểu các phương pháp hay nhất và hướng dẫn về khoản đóng góp của cộng đồng. Thực hiện những đóng góp đầu tiên. Gắn kết cộng đồng – Khám phá cộng đồng. Kiểm tra trạng thái hiện tại của tài liệu về electron. Xác định điểm yếu. Tuần 1 – Điều chỉnh cho phù hợp với cố vấn về các mốc quan trọng và sản phẩm của dự án Tuần 2 – Sửa đổi môi trường nhà phát triển và viết các trang ứng dụng điện tử đầu tiên Tuần 3 – Sửa đổi cấu trúc ứng dụng, thêm tính năng vào ứng dụng, đóng gói ứng dụng và các trang phân phối. Tạo trang tóm tắt có danh sách các tính năng có thể thêm vào ứng dụng Tuần 4 – Tái cấu trúc thư mục tài liệu Tuần 5 – Chuẩn bị mẫu cách tích hợp electron-api-demos vào tài liệu chính Tuần 6 – 7 – Di chuyển electron-api-demos Tuần 8 – Chuẩn bị mẫu cách tích hợp electron-api-demos vào tài liệu chính. Viết đoạn mẫu đầu tiên. Tuần 9 – 10 – Tích hợp electron Fiddle vào tài liệu chính Tuần 11 – Hoàn thiện các trang và cấu trúc tài liệu chính sau khi di chuyển kho lưu trữ electron-api-demos và mẫu electron Fiddle Tuần 12 – Đánh giá kết quả

THÔNG TIN CHI TIẾT VỀ CÁC MỐC QUAN TRỌNG

THỜI GIAN XEM XÉT ỨNG DỤNG Phần đầu tiên của giai đoạn này là kiểm tra kênh cộng đồng, mã nguồn và liên hệ với những người chuyên trách dự án.

Phần thứ hai của giai đoạn này sẽ tập trung vào việc kiểm tra văn hoá đóng góp nói chung, xem xét các hướng dẫn về việc đóng góp và các phương pháp hay nhất. Đây sẽ là lần đóng góp đầu tiên để tìm hiểu cách hoạt động của quy trình.

KẾT NỐI CỘNG ĐỒNG

Lần này chúng ta sẽ tìm hiểu kỹ hơn về thư mục tài liệu cùng với lộ trình của thư mục này. Dựa trên thông tin đó, có thể xác định những điểm yếu (ví dụ: các phần chưa hoàn chỉnh hoặc bị thiếu) có thể cải thiện. Tạo yêu cầu kéo (nếu có thể) để bổ sung dữ liệu còn thiếu.

TUẦN 1 – TUẦN 2

Tuần đầu tiên sẽ dành cho việc giao tiếp với người cố vấn nhằm điều chỉnh các mốc quan trọng dự kiến và khả năng cung cấp nội dung kịp thời của họ.

Tuần thứ hai sẽ là nội dung về việc sửa đổi Môi trường dành cho nhà phát triển và viết các trang Ứng dụng electron đầu tiên của bạn. Đối với trang Môi trường dành cho nhà phát triển, tính năng này sẽ bao gồm việc viết lại thông tin tổng quan chung và hiệu đính. Đối với trang Viết ứng dụng điện tử đầu tiên của bạn, trang sẽ bao gồm việc tạo một hướng dẫn từng bước nhất quán với điểm bắt đầu và điểm kết thúc rõ ràng, loại bỏ thông tin thừa (như hai khối mã tương tự trong phần Phát triển điện tử trong Nutshell và thử phần ví dụ này).

Thành phẩm: Hướng dẫn đã được sửa đổi, dễ làm theo về cách bắt đầu nhanh với các ứng dụng electron.

TUẦN 3

Tuần này sẽ dành riêng cho: 1. các cải tiến của trang Cấu trúc ứng dụng. Điều này bao gồm: – viết lại thông tin hiện có trong phần Quy trình chính và Quy trình kết xuất để giúp độc giả lần đầu thấy dễ dàng và trực quan hơn – bổ sung hình ảnh minh hoạ cấu trúc, cách các quy trình được kết nối, cách chúng giao tiếp và điểm khác biệt cốt lõi. Ví dụ về hình ảnh: Một, Hai, Ba (chất lượng thấp). 2. hợp nhất thông tin về tất cả tính năng bạn có thể thêm vào ứng dụng electron của mình. Điều này bao gồm việc viết lại hướng dẫn để họ có một bộ hướng dẫn thống nhất về cách cài đặt/bật một tính năng kèm theo ví dụ về cách hoạt động của tính năng đó. Ngoài ra, một trang (tóm tắt) mới liệt kê tất cả các tính năng có thể sử dụng sẽ được tạo. Hướng dẫn tổng hợp có thể có dạng như sau: – Tổng quan – Ví dụ: – Mã mẫu – Ví dụ bằng hình ảnh (nếu có thể)

để đơn giản hoá trang Phân phối ứng dụng. Nội dung này bao gồm: a. hợp nhất tính năng Đóng gói ứng dụng vào hướng dẫn Phân phối ứng dụng b. phân chia các phương thức phân phối thành tự động và thủ công c. lấy electron-forge làm ví dụ về phân phối tự động d. lấy thông tin về asar từ trang Đóng gói ứng dụng và mô tả việc sao chép tệp nguồn và tạo kho lưu trữ asar làm ví dụ về phân phối thủ công. #### TUẦN 4 Tuần này sẽ đề cập đến việc tái cấu trúc thư mục tài liệu. Thư mục này bao gồm:

1 – chia các hướng dẫn hiện có theo ít nhất ba danh mục: a. Bắt đầu nhanh b. Tìm hiểu kiến thức cơ bản c. Các bước nâng cao

Danh mục Bắt đầu nhanh sẽ chứa các hướng dẫn cơ bản (cài đặt, cấu hình, phân phối) để tạo một loạt hướng dẫn nhất quán, giúp người mới bắt đầu nhanh từ đầu. Mỗi hướng dẫn phải chứa các đường liên kết đến hướng dẫn trước đó/tiếp theo trong bộ hướng dẫn.

Cấu trúc có thể có dạng như sau: 1. Điều kiện tiên quyết 2. Cài đặt electron 3. Tạo ứng dụng cơ bản 4. Đóng gói/Phân phối ứng dụng

Sau khi hoàn tất phần Bắt đầu nhanh, người dùng sẽ biết thông tin cơ bản về cách hoạt động của ứng dụng electron và sẽ có ứng dụng electron có thể phân phối đầy đủ hoạt động.

Danh mục Tìm hiểu kiến thức cơ bản sẽ bao gồm các hướng dẫn nhằm củng cố kiến thức về electron và mở rộng ứng dụng được tạo trong các phần Bắt đầu nhanh. Những hướng dẫn này bao gồm: – Cấu trúc ứng dụng – Thêm tính năng vào ứng dụng – Boilerplate và CLI

Danh mục Các bước nâng cao sẽ bao gồm các hướng dẫn nâng cao khác nhằm mục đích định cấu hình và tinh chỉnh ứng dụng electron của bạn: – Kiểm tra và gỡ lỗi – Hỗ trợ tiếp cận – Bảo mật – Cập nhật

2 – giảm số lượng trang tài liệu. Phiên bản hiện tại của tài liệu này có nội dung trùng lặp và hướng dẫn chưa được phân loại ở mức độ nhất định. Ví dụ: – Cài đặt và cài đặt electron trong quá trình Viết ứng dụng đầu tiên – Đóng gói và đóng gói ứng dụng vào một tệp trong phần Phân phối ứng dụng – Hướng dẫn chưa được phân loại trong các danh mục Chi tiết và nâng cao: Đề xuất: di chuyển các tài liệu sau sang GitHub và loại trừ khỏi tài liệu chính. Những tài liệu này dành riêng cho các nguyên tắc phát triển electron và kho lưu trữ nguồn là nơi đầu tiên để tìm kiếm những tài liệu này: – Phát triển electron – Phát triển Chromium – Phát triển V8 – Các vấn đề về electron – Bản vá trong electron – Yêu cầu kéo – Cấu trúc thư mục mã nguồn – Kiểm thử – Kiểu mã hoá

Mục đích chính của việc rút gọn này là loại bỏ một số lượng hướng dẫn quá lớn, ghép các thông tin giải đố phân tán lại với nhau và mang đến cho người mới chơi một phiên bản tài liệu về electron nhỏ, có cấu trúc, dễ thao tác và thân thiện với người dùng.

TUẦN 5 – 7

Tuần 5 sẽ được dành riêng để chuẩn bị một mẫu (một cách) về cách tích hợp electron-api-demos vào tài liệu chính. Mẫu này có thể có dạng như sau: 1. Trong tài liệu chính, ở phần "Thêm tính năng vào ứng dụng của bạn", hãy tạo các danh mục được trình bày trong bản minh hoạ electron-api-2. Bằng cách xem qua từng danh mục, hãy chuyển các ví dụ minh hoạ sang tài liệu chính: – Lấy mã mẫu từ mã nguồn hoặc từ nội dung mô tả tính năng tương ứng trong ứng dụng – Mỗi ví dụ được chuyển phải có phần mô tả liên quan

LƯU Ý #1: có các ví dụ tồn tại cả trong electron-api-demos và trong tài liệu chính (ví dụ: phím tắt, kéo và thả). Trong trường hợp này, ví dụ từ electron-api-demos nên được ưu tiên và ví dụ trong tài liệu chính nên được bỏ qua.

LƯU Ý #2: Nhiều ví dụ trong ứng dụng electron-api-demos có bản xem trước Live Demo tính năng hoặc chức năng được mô tả. Chức năng này sẽ bị bỏ qua cho đến khi tích hợp Electronic Fiddle vào Tuần 9-10.

Cập nhật trang liệt kê tất cả tính năng có thể sử dụng (được tạo trong Tuần 3) theo hệ phân cấp ví dụ mới.

Tuần 6 và 7 sẽ được dành riêng để chuyển các ví dụ về electron-api-demos sang tài liệu chính theo mẫu được mô tả ở trên. Ở bước cuối cùng, bạn nên xoá hoặc ngừng sử dụng kho lưu trữ electron-api-demos.

TUẦN 8 – 10

Tuần 8 sẽ dành riêng cho việc chuẩn bị một mẫu (một cách) về cách tích hợp electron Fiddle vào tài liệu chính. Sáng kiến này đã được triển khai (kiểm tra thông tin chi tiết trong vấn đề #20442) bởi các nhân viên của electron cùng với các tình nguyện viên của cộng đồng nhưng việc này cần được hoàn thiện đúng cách.

Để tiếp tục với các mẫu Fiddle, mẫu cơ bản có thể có dạng như sau: 1. Chọn một ví dụ trong tài liệu chính (ví dụ: tài liệu bắt đầu nhanh). Đến thời điểm này, tài liệu cũng nên chứa các ví dụ về electron-api-demos; 2. Tạo lại ví dụ trong Electronic Fiddle (sử dụng mã mẫu hoặc mã nguồn làm điểm xuất phát); 3. Lưu Fiddle cục bộ vào một thư mục; 4. Di chuyển ví dụ vào /docs/fundles/[CATEGORY]/[SECTION]/[demo]. * Danh sách ví dụ đã hoàn tất được mô tả trong phần "Danh sách bản minh hoạ" của vấn đề. 5. Thêm nút "Launch in Fiddle" như mô tả trong nhận xét ban đầu trong vấn đề #2848.

Tuần 9 và 10 sẽ được dành riêng để tích hợp các ví dụ về electron-api-demos (đã được chuyển đổi thành Fiddles) vào tài liệu chính theo mẫu được mô tả ở trên.

TUẦN 11

Tuần này sẽ dành toàn bộ cho việc hoàn thiện dự án viết sau khi di chuyển thành công kho lưu trữ electron-api-demos và các mẫu electron Fiddle. Điều này bao gồm: – kiểm tra để đảm bảo tất cả các ví dụ về mã hiện có đều có nút "Launch in Fiddle" – kiểm tra xem tất cả ví dụ về mã hiện có có hoạt động đúng cách như Fiddles hay không – kiểm tra để đảm bảo rằng tài liệu chính không còn đề cập đến kho lưu trữ electron-api-demos

TUẦN 12

Hoàn tất công việc đã hoàn thành. Kiểm tra chấp nhận.