Skip to content

Hướng dẫn soạn tài liệu

Cấu trúc của một tài liệu

  • Tài liệu được đề cập trong phần tiếp theo đây được hiểu là một quy trình, hướng dẫn, kèm theo đó là diễn giải các biểu mẫu và một biểu mẫu thực tế.

  • Một quy trình, hướng dẫn phải có tối thiểu 3 (ba) thành phần

    • Một bản diễn giải chi tiết quy trình.
    • Một (hoặc nhiều) bản diễn giải chi tiết biểu mẫu sử dụng trong quy trình đó.
    • Một (hoặc nhiều) bản ví dụ cho biểu mẫu đó.

Đóng góp tài liệu

Nhằm chuẩn hóa tài liệu đươc soạn thảo, các đồng chí cần thực hiện theo thứ tự các bước sau: - Sử dụng mẫu quy trình, tạo mới một quy trình hoăc nội dung hướng dẫn cần chuẩn hóa. File đươc lưu đúng đối tượng dành cho quy trình đó. Đặt tên file tiếng Việt, không dấu, không cách, sử dụng gạch nối giữa các từ

  • Sử dụng diễn giải biểu mẫu, tạo một diễn giải biểu mẫu sử dụng trong quy trình đó
  • Đối với mỗi biểu mẫu, phải có một biểu mẫu đã điền sẵn, được lưu tại assets/pdf.

Viết chỉ mục cho quy trình mới

Khi có 1 quy trình và biểu mẫu (do Chi bộ đưa) người có nhiệm vụ cần viết 3 file sau:

  • Bao gồm 3 file: quy trình, file biểu mẫu md, file biểu mẫu pdf.

Quy trình:

  • Xem xét quy trình được đưa sử dụng để làm gì, sau đó ghi lại rõ ràng quy trình thực hiện đó dưới dạng file Markdown (.md) và lưu lại folder đúng mục đích đó. Nếu không có thì tạo folder mới.

  • Tại file quy trình cần lưu ý, ở các bước ghi rõ: có ai tham gia? từng người tham gia cần phải làm gì?

  • Tại file quy trình, nếu có biểu mẫu cần thực hiện liên quan kông link tới file pdf mà link tới file markdown tại Biểu mẫu. Tại file Biểu mẫu mới link tới pdf.

  • File quy trình được lưu lại Quy trình và folder tương ứng.

  • Ví dụ: Nội dung file nêu các điểm chính trong quá trình ghi lý lịch, những lưu ý, ngôn từ sử dụng... Đồng thời có short link dẫn tới biểu mẫu tương ứng với quy trình. Ví dụ trong trừng hợp này thì phải link tới bieu-mau/ket-nap-dang/1.lylich.md

File biểu mẫu md:

  • Tại trang biểu mẫu, có thể giải thích các nội dung trong biểu mẫu. Có short link dẫn tới biểu mẫu thực tế được lưu tại thư mục assets/pdf/.

  • File được viết dưới dạng markdown

  • File biểu mẫu pdf được lưu tại source/bieu-mau/ folder đúng mục đích tương tự file quy trình

File biểu mẫu pdf:

  • Đây là file biểu mẫu đã được điền đầy đủ theo hướng dẫn tại bieu-mau/index.md

  • File biểu mẫu pdf được lưu tại source/assets/pdf

Lưu ý

  • Cách đặt tên file được đặt tên theo: template_quytrinh.md, template_bieumau.md. Lưu tại folder Quy trình, Biểu mẫu tương ứng.

  • Soạn thảo văn bản, bố cục cần có sự thống nhất, văn phong cần chính xác và chuẩn mực.

Dương Trần Trà My