Viết lớp học lập trình

Giới thiệu

Lớp học lập trình là một hướng dẫn tương tác được viết bằng cú pháp Markdown. Chúng tôi xuất bản các lớp học 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 để tạo trải nghiệm hướng dẫn thú vị hơn. Người dùng mục tiêu của lớp học lập trình đang theo dõi và chạy mã khi đọc.

Viết một lớp học lập trình là một cách hay để đó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 cùng một vấn đề dễ dàng hơn.

Điều gì tạo 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 chất lượng cao phải tập trung và dễ đọc. Hướng dẫn này cho người dùng biết rõ họ sẽ xây dựng gì và học được gì, đồng thời hướng dẫn người dùng cách viết và hiểu mã để hoàn thành một nhiệm vụ cụ thể.

Quy trình

Nếu có ý tưởng cho một lớp học lập trình, bạn có thể chia sẻ ý tưởng đó với chúng tôi bằng cách gửi yêu cầu về tính năng trong kho lưu trữ blockly-samples. Thêm nội dung mô tả về nội dung bạn muốn dạy và nội dung bạn sẽ xây dựng trong lớp học lập trình. Chúng ta sẽ thảo luận và tinh chỉnh ý tưởng này. Sau đó, bạn có thể viết mã và gửi yêu cầu thay đổi cho mã đó. Sau khi xem xét, một thành viên trong nhóm Blockly sẽ xuất bản mã đó.

Mẹo khi viêt

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

Hãy xem bài viết Kỹ năng viết kỹ thuật 1 để tìm hiểu nhanh về kỹ năng viết kỹ thuật.

Đối tượng

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

Thiết lập

  • Người dùng cần thiết lập tối thiểu những gì để chạy mã của bạn?

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

Cấu trúc

Giống như mọi bài viết khác, hãy bắt đầu bằng một dàn ý. Đây là cấu trúc phù hợp với 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 phải biết
    • Hướng dẫn thiết lập
  • Bước 1: [Tiêu đề ở đây]
    • 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
    • Tài nguyên khác
    • Đường liên kết đến mã hoàn chỉnh (nếu có)

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

Kiểu viết

  • Sử dụng văn phong trò chuyện.
  • Sử dụng tiêu đề để sắp xếp rõ ràng.
  • Sử dụng danh sách có dấu đầu dòng để chia nhỏ các đoạn văn bản dài.
  • Sử dụng hình ảnh và ảnh GIF!

Kiểu mã