Bắt đầu mọi thứ với tài liệu kỹ thuật. Bạn đã hình thành thói quen này chưa?

  • 0

  • 0

  • 0

Bắt đầu mọi thứ với tài liệu kỹ thuật. Bạn đã hình thành thói quen này chưa?

Bắt đầu mọi thứ với tài liệu kỹ thuật. Bạn đã hình thành thói quen này chưa?

Vấn đề

Một trong những kỹ năng quan trọng trong ngành IT nhưng lại đang bị nhiều người bỏ qua đó chính là "đọc tài liệu".

Docs, Documents hay là Tài liệu kỹ thuật là một tập hợp ghi chép tất tần tật về một ngôn ngữ, phần mềm, công cụ… Lý do để chúng được sinh ra là để hướng dẫn cho chúng ta cách sử dụng. Bên cạnh đó Docs còn chứa những thông tin quan trọng để giúp đỡ chúng ta nghiên cứu cũng như gỡ lỗi.

Do vậy, một trang Docs có thể rất dài khiến cho chúng ta bị choáng, thâm chí là chán nản với việc đọc chúng. Khối lượng kiến thức mà trong Docs muốn truyền tải phải nói là rất khô khan, càng nặng khi độ phức tạp của thư viện càng lớn.

Nhưng cũng chính vì thế, Docs mang lại rất nhiều thông tin quan trọng giúp bạn tiếp cận với công cụ sắp sửa tìm hiểu. Tôi đã từng khuyên nhiều người trước khi đặt câu hỏi hãy dành thời gian nghiên cứu tài liệu nhưng có vẻ rất ít người lắng nghe, một phần vì họ sợ mất thời gian và một phần vì không biết bắt đầu đọc từ đâu, đọc như thế nào. Vậy thì đọc tài liệu có thực sự đáng sợ như lâu nay bạn vẫn nghĩ hay làm sao để vượt qua định kiến đó?

Thực tại

Thực tại

Ngày ngay nhịp điệu của cuộc sống đòi hỏi chúng ta phải nạp nguồn kiến thức sao cho vừa nhanh mà lại vừa dễ hiểu. Nhưng chớ trêu thay nếu muốn nhanh thì khả năng cao thì sẽ không trọn vẹn và ngược lại.

Những bài viết ngắn trên các trang mạng, blog có vẻ được mọi người yêu thích bởi vì tính thời sự và thời gian tiếp nhận thông tin tương đối ngắn. Có khi chỉ cần đọc một lần là có thể nắm bắt được ngay. Điều đó hoàn toàn đúng bởi vì những bài viết đó phần lớn chỉ nói vào một khía cạnh nào đó nên khiến người đọc có cảm giác biết rõ công cụ, nhưng thực ra lượng kiến thức khác chẳng hạn như Mô tả, Kiến trúc, Các thuật ngữ kĩ thuật, Danh sách tính năng đầy đủ… lại nằm ở trong Docs.

Tôi tiếp xúc với nhiều người và thường thấy họ không mấy khi có thói quen đọc Docs. Bằng chứng là họ hay hỏi tôi những câu rất cơ bản, những câu hỏi đó chỉ cần dành ít thời gian xem qua tài liệu là có thể tự trả lời được. Nhưng xem ra họ vẫn chưa rèn luyện cho mình kĩ năng đọc tài liệu và chắc chắn đó là một thói quen không tốt.

Tầm quan trọng của đọc tài liệu

Thường xuyên đọc docs giúp bạn hình thành thói quen đọc mỗi khi học một công cụ gì đó đó mới. Tự mình nghiên cứu, tìm hiểu; chủ động giải quyết những tình huống sau này khi làm việc mà có thể không cần nhờ đến bất kì ai vì lượng kiến thức bạn thu nạp được trong docs đã đủ dùng.

Có một cái nhìn từ bao quát đến chi tiết của công cụ, biết được công cụ làm gì hay những tính năng mà công cụ cung cấp. Hay thậm chí biết được cả cách hoạt động và kĩ thuật debug trong giải quyết vấn đề. Từ đó nâng cao khả năng sử dụng và nghệ thuật gỡ lỗi cũng lên tầm cao mới.

Các kiến thức nâng cao, chuyên sâu trong tài liệu mô tả về công cụ nếu như bạn muốn sử dụng thành thạo công cụ đó. Hiểu rõ bản chất của công cụ giúp bạn nâng cao tầm hiểu biết cũng như cách sử dụng thành thạo, hơn nữa bạn còn có thể đóng góp (contribution) cho dự án nếu được phép làm điều đó.

Phương pháp đọc tài liệu

Cách đọc

Khi đã hiểu ra tầm quan trọng của việc nghiên cứu tài liệu bước tiếp theo chúng ta sẽ học cách đọc.

Phải nói rằng tài liệu ngày nay được quan tâm và đầu tư rất tốt, về nội dung, các đầu mục đa số được trình bày theo một mẫu chung, giúp cho chúng ta dễ dàng tiếp cận. Nếu bạn mới bắt đầu đọc thì hãy để ý, sau này bạn sẽ thấy đa số chúng sẽ có điểm chung và việc ý thức được điều đó giúp cho bạn tiếp cận những tài liệu sau này nhanh hơn bình thường.

Trước khi bắt đầu tìm hiểu vào sâu hơn, hãy dành thời gian để đọc phần giới thiệu để biết thư viện, công cụ có thể làm được gì. Thông tin này có thể ngắn gọn nhưng lại đóng phần quan trọng vì nó quyết định đến việc bạn có nên tiếp tục với công cụ hay công cụ liệu có giải quyết được vấn đề bạn đang gặp phải hay không.

Sau đó tiếp tục với phần Quickstart để xem cách sử dụng thư viện nhanh và đơn giản nhất. Quickstart là nơi chỉ dẫn cho bạn cách cài đặt và sử dụng thư viện một cách nhanh nhất, đó có thể là cách triển khai, những hàm cơ bản nhất để bạn bắt đầu với thư viện. Thông qua Quickstart bạn cũng có thể hình dung được ra độ phức tạp của công cụ sắp tìm hiểu để chuẩn bị tinh thần tốt hơn.

Một số tài liệu có mục Tutorial để hướng dẫn bạn chi tiết cách sử dụng thư viện. Đây là một loạt các bài viết hướng dẫn từ A-Z để giúp bạn cách triển khai một hoặc nhiều tính năng mà công cụ cung cấp. Thông qua Tutorial sẽ chỉ cho bạn cách triển khai mã mà thư viện cung cấp sao cho tốt nhất, phải nói đây là một mục rất có ích mà không phải tài liệu nào cũng có. Vì thế nếu tài liệu nào có mục Tutorial thì nhất định bạn phải thử đọc.

Tiếp tục đọc đến những đầu mục khác mà tài liệu liệt kê ra trong mục Menu. Mục đích chính là để xem công cụ còn cung cấp những kiến thức gì. Vì mục đích mỗi công cụ là khác nhau và phụ thuộc vào nhóm phát triển nên lượng thông tin muốn truyền tải cũng đa dạng. Bạn cần đọc để xem công cụ còn cung cấp thêm những tính năng nào khác phục vụ cho việc giải quyết vấn đề sau này không.

Một số tài liệu trình bày tư tưởng, mô hình kiến trúc công cụ của họ cho nhưng ai quan tâm và cả cách đóng góp (contribution) vào thư viện. Nếu cảm thấy yêu thích và muốn đóng góp bạn có thể đọc tiếp, còn không đọc để hiểu về kiến trúc cũng là một hình thức tích lũy thêm kiến thức cho mình.

Ngoài ra còn có thể có một mục có tên API Reference là nơi phân loại, liệt kê ra đầy đủ và chi tiết tất cả API có trong thư viện cho mọi người dễ dàng tra cứu. Các Class, Function, Options… mà công cụ cung cấp có thể rất nhiều mà chúng ta không thể nhớ hết các thông số cũng như các dùng chúng, thông qua đây là nơi tra cứu nhanh vấn đề trên.

Một điều nữa đáng quan tâm là đa số tài liệu được viết bằng tiếng Anh. Tuy nhiên thời đại ngày nay có nhiều công cụ giúp chúng ta dịch được nhiều thứ tiếng. Như bản thân tôi là người có vốn tiếng Anh không tốt nhưng tôi có thói quen sử dụng Google Translate để dịch tài liệu.

Tổng kết

Tài liệu là một phần quan trọng của bất kì công cụ IT nào, nhờ có tài liệu mà chúng ta mới có thể tiếp cận công cụ một cách dễ dàng hơn. Quá trình nghiên cứu tài liệu có thể tốn thời gian nhưng bù lại bạn sẽ chủ động trong quá trình học tập và làm việc sau này.

Bạn thấy bài viết này có ích?
  • Không

  • Bình thường

Bình luận
DMCA.com Protection Status