Cách viết một lớp học lập trình hiệu quả

Giới thiệu

Lớp học lập trình là một phần hướng dẫn có tính tương tác được viết bằng cú pháp markdown. Chúng tôi phát hành các phòng thí nghiệm lập trình tại blocklycodelabs.dev. Các lớp học lập trình sử dụng kết hợp ngôn ngữ tự nhiên, mã mẫu và ảnh chụp màn hình để mang đến trải nghiệm hướng dẫn thú vị hơn. Người dùng mục tiêu của một lớp học lập trình đang theo dõi và chạy mã khi họ đọc.

Việc viết một lớp học lập trình là một cách tuyệt vời để đóng góp cho cộng đồng. Đây là một cách để chia sẻ kiến thức của bạn và giúp nhà phát triển tiếp theo gặp phải vấn đề tương tự dễ dàng hơn.

Điều gì làm nên một lớp học lập trình hiệu quả?

Một lớp học lập trình tuyệt vời thường có trọng tâm và dễ đọc. Mã này cho người dùng biết rõ những gì họ sẽ tạo và nội dung họ sẽ học, đồng thời hướng dẫn người dùng cách viết và tìm hiểu mã để hoàn thành một nhiệm vụ cụ thể.

Quy trình

Nếu có ý tưởng về một lớp học lập trình, bạn có thể cho chúng tôi biết bằng cách gửi yêu cầu về tính năng trong kho lưu trữ mẫu khối. Thêm nội dung mô tả nội dung bạn muốn giảng dạy và những gì bạn sẽ xây dựng trong lớp học lập trình này. Chúng ta sẽ thảo luận và tinh chỉnh ý tưởng. Sau đó, bạn có thể viết và gửi yêu cầu lấy dữ liệu cho yêu cầu đó. Sau khi ứng dụng được xem xét, một thành viên của nhóm Blockly sẽ xuất bản ứng dụng đó.

Mẹo khi viêt

Phần còn lại của trang này là bộ các mẹo và câu hỏi nhằm hướng dẫn bạn cách viết lớp học lập trình.

Hãy xem bài viết Kỹ thuật Viết One để tìm hiểu nhanh về cách viết kỹ thuật.

Đối tượng người xem

  • Độc giả mục tiêu là ai?
  • Họ đã biết những gì về việc sử dụng tính năng Blockly?
  • Họ đang cố gắng tìm hiểu điều gì?

Thiết lập

  • Người dùng phải thiết lập tối thiểu bao nhiêu để chạy mã của bạn?

Nếu thấy hữu ích, bạn có thể phát hành mã khởi động và mã hoàn chỉnh trong thư mục examples.

Cấu trúc

Giống như với mọi bài viết, hãy bắt đầu bằng một đề cương. Đây là cấu trúc phù hợp cho hầu hết các lớp học lập trình:

  • Giới thiệu
    • Kiến thức bạn sẽ học được
    • Sản phẩm bạn sẽ tạo ra
    • Những điều bạn cần biết
    • Hướng dẫn thiết lập
  • Bước 1: [Title goes here]
    • Giải thích/động lực
    • Mã mẫu
    • Kết quả dự kiến
    • (Không bắt buộc) Giải thích thêm
  • ...
  • Bước 10: [Title goes here]
  • Tóm tắt
    • Kiến thức bạn học được
    • Sản phẩm bạn đã tạo ra
    • Tài nguyên khác
    • Đường liên kết đến đoạn mã đã hoàn tất (nếu có)

Mặc dù bạn có thể có hơn 10 bước, nhưng nếu đạt đến 20 bước, bạn nên cân nhắc việc chia nhỏ thành hai lớp học lập trình.

Phong cách viết

  • Sử dụng văn phong mang tính trò chuyện.
  • Sử dụng tiêu đề để làm rõ cách sắp xếp.
  • Sử dụng danh sách có dấu đầu dòng để phá vỡ các bức tường văn bản.
  • Sử dụng hình ảnh và GIF!

Kiểu mã