Toss công bố hướng dẫn technical writing
(technical-writing.dev)Các nguyên tắc cốt lõi để viết tài liệu kỹ thuật tốt
1. Xác định loại tài liệu
Tùy theo mục đích của tài liệu, cách viết hiệu quả sẽ khác nhau
- Tài liệu thiên về học tập: nhằm nắm được luồng tổng thể khi lần đầu tiếp cận một công nghệ hoặc công cụ mới
- Tài liệu giải quyết vấn đề: nhằm xử lý một vấn đề cụ thể khi đã có kiến thức nền
- Tài liệu tham chiếu: dành cho trường hợp đã biết cách sử dụng, nhưng muốn kiểm tra một tính năng cụ thể hoặc cách dùng API
- Tài liệu giải thích: nhằm hiểu sâu về khái niệm, nguyên lý và kiến thức nền
2. Xây dựng cấu trúc thông tin
Việc hiểu kiến thức mới đòi hỏi nỗ lực, nhưng nếu cấu trúc hóa thông tin thì có thể giảm bớt nỗ lực đó
- Mỗi trang chỉ nói về một nội dung
- Cung cấp giá trị trước
- Viết tiêu đề hiệu quả
- Đừng bỏ qua phần tổng quan
- Làm cho nội dung có thể dự đoán được
3. Gọt giũa câu văn
Khi tăng khả năng truyền đạt của câu văn, người đọc có thể hiểu nội dung dễ hơn. Nếu chi tiết được diễn đạt bằng những câu khó hiểu thì khả năng truyền tải sẽ giảm đi rất nhiều
- Làm rõ chủ thể của câu
- Chỉ giữ lại thông tin cần thiết
- Viết cụ thể
- Dùng cách diễn đạt tự nhiên
- Viết nhất quán
6 bình luận
Có nơi nào tổng hợp các trang web như thế này do Toss tạo ra không?
Cách nói kiểu 'yo' thật khó để quen.
Đúng vậy.
Hay đấy, đặc biệt phần gọt câu chữ thì chắc tôi sẽ thử tạo bằng GPTs theo kiểu few-shot để dùng.
Mình thấy những bài viết như thế này rất hay. Trong thời đại LLM, những hướng dẫn như vậy có thể sẽ được biến đổi như thế nào?
Đây đúng là một dự án rất hay ^^