- Công cụ soạn thảo
- Công cụ trực quan hóa
- Công cụ tự đồng bộ tạo Book Online
- Công cụ tự đồng bộ tạo Slide
- Công cụ lưu trữ, quản lý tài liệu
Tài liệu này được thiết kế dành cho nhân viên của FoxAI khi cần thực hiện các công việc như:
- Viết tài liệu đào tạo để chuyển giao cho khách hàng;
- Tạo slide thuyết trình sản phẩm hoặc kế hoạch kinh doanh;
- Xây dựng tài liệu, quy trình, quy định để đào tạo nội bộ.
Giúp nâng cao năng suất, thực hiện một cách dễ dàng, chuyên nghiệp, và hiệu quả.
Người dùng sau khi đọc tài liệu này có thể:
- Biết được cách dùng Markdown, HTML... để ghi chú, soạn thảo nội dung một cách nhanh chóng, dễ chỉnh sửa, dễ truyền tải.
- Nắm được các công cụ Mermaid, Markmap, Badge, Kroki... để vẽ biểu đồ, workflow giúp trực quan hóa tài liệu.
- Thực hành được cách đồng bộ tự động nội dung trên GitHub sang GitBook để xuất bản sách hướng dẫn nhanh, dễ dàng chia sẻ cho khách hàng, luôn đảm bảo update mà không phải sửa thủ công.
- Biết cách cập nhật nội dung từ GitHub sang HackMD để tạo slide trình chiếu chuyên nghiệp, nhanh chóng.
- Hiểu được cách thức lưu trữ thông qua công cụ Git đảm bảo tính nhất quán, tránh xung đột khi nhiều nhân viên cùng tham gia chỉnh sửa hoặc cập nhật.
graph TD;
1.Soạn_thảo_nội_dung --> 2.Trực_quan_hóa --> 3.Xuất_bản_tài_liệu --> 4.Thuyết_trình --> 5.Lưu_trữ_tài_liệu
- Markdown là ngôn ngữ đánh dấu đơn giản, cho phép viết tài liệu nhanh chóng, gọn nhẹ. Định dạng đuôi là
.md. - Kết hợp với GitHub, GitBook, HackMD… bạn dễ dàng tạo trang doc, slide, blog mà không cần các công cụ soạn thảo nặng nề.
- Tiêu đề:
# Tiêu đề cấp 1 ## Tiêu đề cấp 2 ### Tiêu đề cấp 3
- Đoạn văn in đậm, in nghiêng:
Đây là **chữ in đậm** và *chữ in nghiêng*.
- Danh sách:
- Gạch đầu dòng 1 - Gạch đầu dòng 2 1. Mục thứ nhất 2. Mục thứ hai
- Chèn link, hình ảnh, trích dẫn:
[Link đến Google](https://google.com) 
- Chèn ảnh động .gif /video với kích thước tùy chỉnh thì sử dụng cú pháp HTML:
#1.Tải ảnh lên thư mục Image của GitHub #2.Chèn Ảnh với Kích Thước 50% <img src="Image/example.gif" width="50%" />
- Dòng code lệnh:
```python print("Hello World")
- Dòng kẻ/ngăn cách trang slide:
---
Xem thêm tại: Basic writing and formatting syntax
- Tạo repository / file Markdown
- Đăng nhập GitHub → Tạo repo mới (hoặc mở repo sẵn có).
- Tạo file .md (ví dụ: README.md, doc-tong-quan.md).
- Viết nội dung Markdown, commit lên repo. Mọi thay đổi (commit) trong file .md sẽ được Git lưu lại.
-
HTML là ngôn ngữ thường dùng để viết tài liệu có cấu trúc rõ ràng, thường viết bằng công cụ như Visual Studio Code VSCode để dễ dàng kiểm tra nội dung.
-
Khi mở file
.htmltrên GitHub, mã HTML sẽ hiển thị dưới dạng văn bản chứ không được render thành trang web, do vậy để xem thì phải render thông qua GitHub Pages. -
Ngôn ngữ HTML thường kết hợp Markdown để tăng tính tương tác trong tài liệu, ví dụ HTML hỗ trợ tốt các tính năng như: thay đổi font, màu sắc, kích thước ảnh...
Xem thêm:
Nhằm giúp thông tin dễ hiểu hơn, hấp dẫn hơn, và hỗ trợ người đọc nắm bắt ý chính nhanh chóng, chúng ta thường dùng các cách thức như: vẽ biểu đồ workflow, đồ thị chart, sơ đồ mindmap, chèn hình ảnh minh họa và biểu tượng icon, infographic và kết hợp đa phương tiện như video, âm thanh, hoặc liên kết (link) đến tài liệu khác.
Mermaid là nền tảng giúp bạn vẽ nhanh các diagram nhanh chóng và có thể chèn trực tiếp vào Markdown mà không cần xuất ra ảnh để chèn vào tài liệu.
Các bước thực hiện:
- Lựa chọn dạng biểu đồ: Flowchart, Sequent Diagram, Hierachy, TopDown hay LeftRight...
- Viết code biểu đồ ```mermaid
- Copy code sang GitHub, chú ý bổ sung ``` ở cuối dòng
```mermaid graph LR; Markdown --> Mermaid --> GitHub --> GitBook --> HackMD ```
Biểu đồ sẽ có dạng như sau:
graph LR;
Markdown --> Mermaid --> GitHub --> GitBook --> HackMD
Ngoài ra, Mermaid cũng hỗ trợ tạo sơ đồ Mindmap như sau:
mindmap
root((So sánh Phương án Kinh doanh Chatbot AI))
Localhost
Chi phí
Cao: 5-7 tỷ VNĐ
Phí triển khai ban đầu lớn
Thời gian
6-9 tháng triển khai
Tập trung vào phát triển và tối ưu hóa nội bộ
Đối tượng khách hàng
Doanh nghiệp lớn, yêu cầu bảo mật cao
Ngành: tài chính, ngân hàng, y tế, giáo dục
API
Chi phí
Thấp: 2-4 tỷ VNĐ
Phí sử dụng linh hoạt theo tháng
Thời gian
3-5 tháng triển khai
Nhanh chóng nhờ tích hợp API có sẵn
Đối tượng khách hàng
Doanh nghiệp vừa và nhỏ
Ngành: bán lẻ, dịch vụ, thương mại điện tử
Markmap.js là một nền tảng giúp chuyển đổi Markdown thành mindmap (sơ đồ tư duy) trực quan và tương tác, sử dụng trực tiếp trên trình duyệt (dưới dạng HTML).
Giao diện website được chia làm 2 phần:
Khung bên trái:
- Nơi bạn nhập nội dung Markdown. Nội dung này sẽ được chuyển thành mindmap. Ví dụ:
# Tài liệu Hướng Dẫn Sử Dụng
## Giới thiệu
- Tổng quan về phần mềm
- Mục đích sử dụng
## Sử dụng
- Tạo tài liệu mới
- Chỉnh sửa tài liệu
- Thêm nội dung
- Xóa nội dung
- Xuất tài liệu
- PDF
- HTML
## Tài liệu tham khảo
- Hướng dẫn sử dụng chi tiết
- FAQ
## Ghi chú
- Thường xuyên cập nhật phần mềm
- Lưu ý bảo mật tài liệuKhung bên phải:
- Hiển thị sơ đồ mindmap tương tác được tạo từ nội dung Markdown bạn nhập.
Bạn có thể tải file mindmap về dưới dạng .html, rồi tải lên GitHub Pages để xem trực tiếp trong tài liệu.
Badge là các biểu tượng/huy hiệu hiển thị trạng thái, thông tin hoặc số liệu quan trọng, thường được sử dụng trong README.md để cung cấp thông tin nhanh (ví dụ: tình trạng dự án, phiên bản của tài liệu, cấp độ bảo mật, license...) và tăng tính chuyên nghiệp, dễ đọc, hiện đại và bắt mắt hơn.
Ví dụ:
Kroki là nền tảng cho phép bạn tạo URL để nhúng sơ đồ PlantUML, GraphViz... bằng cách dán mã Markdown để tạo hình ảnh dưới dạng .png, .jpg, .svg, .pdf, .txt hoặc base64. Điểm mạnh so với Mermaid là có thể tạo đa dạng sơ đồ hơn nhưng hạn chế là không thể chỉnh sửa trực tiếp ngay trong GitHub.
Các bước thực hiện:
Bước 1: Vào trang PlantUML để tạo cú pháp tạo mindmap, ví dụ như:
@startmindmap
*[#Orange] Colors
**[#lightgreen] Green
**[#FFBBCC] Rose
**[#lightblue] Blue
@endmindmap
Bước 2: Vào trang Kroki để tạo url, ví dụ như:
https://kroki.io/plantuml/svg/eNpzKC5JLCrJzcxLyU0s4NKKVvYvSsxLT41VcM7PyS8q5tICCuVkpmeUpBelpubFKriDKLCom5uTk7NzrEJQfnEqQllSTilQsxOQ5HJIBRoKNRgAE0MiXw==
Bước 3: Cập nhật vào tài liệu trên GitHub bằng cú pháp:
GitBook là nền tảng giúp bạn tạo trang tài liệu/sách online chuyên nghiệp, có thể mời người khác cộng tác chỉnh sửa và chia sẻ cho khách hàng.
GitBook có thể sync từ file Markdown từ GitHub, khi chỉnh sửa trên GitHub thì GitBook tự động cập nhật theo.
- Tạo Space trên GitBook
- Thêm Page và sync đồng bộ từ GitHub
- Edit changes, chia sẻ và publish to web.
HackMD là nền tảng soạn thảo Markdown online, hỗ trợ chế độ trình chiếu (Slide mode) dựa trên Reveal.js. Bạn có thể dán file Markdown (copy/paste) hoặc sync một phần với GitHub (chức năng “Import from GitHub” hoặc “Publish to GitHub”).
- Đăng nhập bằng GitHub account, thực hiện sync
- Chọn “New Note” → “Import from GitHub Gist / GitHub repo”
- Chọn file .md trong repo.
- Mọi thay đổi trên GitHub sẽ được sync với HackMD (Hoặc bạn có thể copy/paste nội dung Markdown từ GitHub sang HackMD).
- Chỉnh sửa nội dung Markdown đã có trên HackMD (nếu cần)
- Thêm --- để chia slide.
- Bấm Menu → Slide mode (hoặc “Present Slides”).
- Nếu muốn tùy chỉnh theme, transition, CSS… → sử dụng YAML front matter (khóa reveal Options).
Git là Hệ thống Quản lý Phiên bản VCS (Version Control System) giúp quản lý tài liệu, theo dõi phiên bản thay đổi, chia sẻ việc sửa cho nhóm và giữ được lịch sử chỉnh sửa tài liệu thông qua một số nền tảng: GitHub, GitLab, hoặc Bitbucket.
1.Các thao tác với kho lưu trữ từ xa (Remote Repository)
- Liên kết kho lưu trữ từ xa bằng link online hoặc GitHub Desktop
- Tải tài liệu lên kho lưu trữ Repo
- Thành viên trong team có thể tải hàng loạt tài liệu bằng lệnh
Git clone:
git clone https://github.com/username/repository-name.git
2.Quản lý phiên bản
- Tạo nhánh (fork) để chỉnh sửa mà không ảnh hưởng đến tài liệu gốc
- Tạo Commit history sau mỗi lần chỉnh sửa
- Tạo Pull request để gửi yêu cầu phê duyệt tài liệu
- Hợp nhất thay đổi (merge) hoặc phê duyệt thay đổi tài liệu
- Nếu nhiều người cùng chỉnh sửa một file, Git sẽ báo xung đột để tạo ra 2 phiên bản khác
3.Một số cách thức quản lý tài liệu hiệu quả
Quy tắc:
- Quy định rõ cấu trúc tài liệu (ví dụ: đặt tên file, thư mục).
- Quy định cách ghi chú thay đổi (changelog).
Phân Quyền Rõ Ràng:
- Ai có quyền chỉnh sửa, nhận xét, hoặc chỉ xem.
- Sử dụng công cụ hỗ trợ phân quyền như Google Workspace, Confluence.
Thiết lập Quy trình Kiểm Duyệt:
- Áp dụng quy trình phê duyệt thay đổi trước khi ban hành.
- Sử dụng Git (Pull Request) hoặc Google Docs (Suggested Edits).
Đặt Lịch Kiểm Tra Định Kỳ:
- Xác định ngày kiểm tra và cập nhật tài liệu định kỳ (hàng quý, hàng năm).
- Sử dụng các công cụ nhắc lịch như Google Calendar hoặc Microsoft Outlook.
Sử dụng các công cụ như Zapier hoặc Make (Integromat) để tự động:
- Thông báo thay đổi tài liệu.
- Gửi tài liệu mới đến các bên liên quan (Lập trình viên, Tư vấn, Kinh doanh, Khách hàng...)
Với tài liệu hướng dẫn này, các nhân viên FoxAI sẽ có công cụ và quy trình rõ ràng để tạo ra những tài liệu chuyên nghiệp, hiệu quả và luôn được cập nhật. Điều này không chỉ nâng cao chất lượng dịch vụ mà còn cải thiện khả năng hỗ trợ khách hàng và đào tạo nội bộ.