Skip to content

Check list refactor course

Thaycacac edited this page Sep 10, 2023 · 4 revisions

Guideline refactor course

Intro

Hiện tại một số course mình tự viết, một đa số các course mình đang tham khảo source bên khác là nhiều và một số course chưa được update lại content nên có thể cũng đã bị out date khá nhiều

=> Chúng ta cần tập trung cập nhật lại course này cho thật xịn => Mục tiêu kungfutech là trang tài liệu học lập trình số 1 VN

Nội dung refactor

Về cấu trúc

  • Kiểm tra xem cấu trúc thư mục đã ổn hay chưa? bao gồm chương, các bài viết trong chương => nếu thiếu thì cần bổ sung, nếu chưa hợp lý thì tái cấu trúc lại cho hợp lý

Về nội dung

  • Cần kiểm tra tiêu đề, description, tên chương, thứ tự bài đã đúng chưa
  • Kiểm tra xem phần hình ảnh có bị lỗi không? hình ảnh đã có alt chưa, nếu chưa hoặc mặc định => thì cần thêm alt cho hình ảnh
  • Phần output cần dùng thẻ <content-result>
  • Các phần nội dung cần highlight như infor, warning, success, danger thì dùng như thế này
::alert{type="infor"}
This is infor content
::

::alert{type="warning"}
This is warning content
::

::alert{type="success"}
This is success content
::

::alert{type="danger"}
This is danger content
::


::alert{type="warning"}
This is example content
::

Output sẽ như sau:

image

Example: https://github.com/techmely/hoc-lap-trinh/commit/736007c1a3735d3531f9810f182d64d5dc4f2adb

  • Quan trọng nhất là đọc lại nột dung xem đã dễ hiểu hay chưa, có bị out date không (có thể sử dụng các tool như chat gpt để resolve)
Clone this wiki locally