Dự án BRL-CAD

Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.

Tóm tắt dự án

Tổ chức nguồn mở:
BRL-CAD
Người viết nội dung kỹ thuật:
sahibkaur
Tên dự án:
Hướng dẫn cho người mới bắt đầu sử dụng BRL-CAD
Thời lượng dự án:
Thời gian tiêu chuẩn (3 tháng)

Mô tả dự án

Hướng dẫn cho người mới bắt đầu về BRL-CAD

Bản tóm tắt dự án

Dự án này nhằm tạo tài liệu dành riêng cho người dùng không chỉ mới sử dụng BRL-CAD mà còn mới sử dụng mã nguồn mở.

Tại sao có dự án này

Khi mới truy cập vào trang web BRL-CAD, do mới sử dụng mã nguồn mở và BRL-CAD, nên tôi đã bị choáng ngợp trước lượng thông tin mỗi lần truy cập. Nhưng trong sâu thẳm, tôi biết có rất nhiều điều để tìm hiểu ở đây. Vì vậy, tôi muốn tạo tài liệu cho những người dùng mới như tôi để có thể hiểu rõ cộng đồng này và cảm thấy thoải mái khi bắt đầu.

Bàn thắng

Dự án này sẽ nhắm đến người dùng mới. Vì vậy, sau đây là một số điểm mà tài liệu của tôi hướng tới: Để đảm bảo người dùng mới cảm thấy thoải mái: Tài liệu này dành cho người dùng mới, không chỉ mới sử dụng BRL-CAD mà còn dành cho người mới sử dụng mã nguồn mở.

Để đạt được điều này, tôi sẽ:

  • Bạn hãy nhớ duy trì điểm Flesch-Kincaid của giấy tờ tối thiểu trên 50. Theo phương pháp Flesch-Kincaid, điểm số càng cao thì tác phẩm càng dễ hiểu. Bạn có thể kiểm tra điểm số về khả năng đọc trực tuyến.
  • Sử dụng danh sách có dấu đầu dòng hoặc danh sách được đánh số để người đọc không cảm thấy buồn chán hoặc bị phân tâm bởi các đoạn văn dài.
  • Hãy dùng các đoạn văn và câu ngắn hơn vì việc này đòi hỏi người học phải vận dụng trí óc nhiều hơn để đọc và hiểu các câu dài.
  • Sử dụng tiêu đề phụ để chia nhỏ văn bản. Tài liệu có cấu trúc hợp lý: Tài liệu có cấu trúc hợp lý đóng vai trò quan trọng trong việc hướng dẫn người dùng mới. Điều đó giúp họ không bị mất phương hướng và cho họ biết họ đang đi đến đâu và đang làm gì. Để đạt được điều này, tôi đã xây dựng một sơ đồ tư duy sơ sài để có thể ghi lại hướng dẫn cho người mới bắt đầu này một cách có tổ chức.

Nội dung mô tả dự án

Dự án này tập trung vào việc viết tài liệu giúp những người dùng mới sử dụng phần mềm này.

Dưới đây là ví dụ về cách tôi dự định tạo tài liệu mô tả cụ thể hơn.

Giới thiệu cơ bản: BRL-CAD (phát âm là be-are-el-cad) là một thiết kế có sự hỗ trợ của máy tính (CAD) trong mô hình hình học rắn (CSG) xây dựng. Đây là một hệ thống lập mô hình vững chắc mã nguồn mở, mạnh mẽ, đa nền tảng, dành cho thiết kế 3D và trực quan hoá đồ hoạ bằng máy tính. Bạn chưa biết cách quan sát? Cùng phân tích thật kỹ nào. Nguồn mở: Phần mềm nguồn mở là phần mềm có mã nguồn mà bất kỳ ai cũng có thể kiểm tra, sửa đổi và nâng cao. BRL-CAD là một phần mềm nguồn mở hoan nghênh bạn đóng góp và giúp cho BRL-CAD tốt hơn trước đây! Thiết kế hỗ trợ máy tính (CAD): Nói một cách đơn giản, CAD là việc sử dụng các chương trình máy tính để tạo bản trình bày đồ hoạ hai hoặc ba chiều của các đối tượng thực tế. Hệ thống mô hình hoá rắn: BRL-CAD tập trung vào mô hình CAD đặc. Mô hình rắn được phân biệt với các dạng mô hình hoá hình học khác bởi chú trọng vào tính chính xác vật lý, mô tả đầy đủ không gian 3D. Công cụ này mô phỏng một đối tượng cả bên trong lẫn bên ngoài. Xây dựng khối hình học rắn (CSG): CSG cho phép biểu diễn các mô hình phức tạp dưới dạng một chuỗi các phép toán Boolean giữa các dữ liệu nguyên gốc. Các đối tượng rắn đơn giản nhất dùng để biểu diễn được gọi là dữ liệu nguyên thuỷ. Để tìm hiểu về CSG ở cấp độ cơ bản, hãy truy cập vào đây.

*Như đã đề cập trong phần mô tả ý tưởng dự án: Tài liệu này sẽ tối thiểu bao gồm việc cài đặt cơ bản, mô tả tổng thể về các chức năng, nguyên tắc lập mô hình của BRL-CAD, cách sử dụng cơ bản các công cụ chính, tạo mô hình, nhập/xuất, phân tích và kết xuất.

Cùng dòng là những đoạn mở đầu ngắn gọn về cách tôi trình bày từng phần trong tài liệu.

  • Cài đặt cơ bản: Tôi sẽ thêm hướng dẫn từng bước để cài đặt phần mềm BRL-CAD cùng với ảnh chụp màn hình bắt buộc. Hướng dẫn dành cho người mới là một nơi tuyệt vời để người dùng mới bắt đầu. Một số mục tôi thấy bị thiếu là:
  • Các bước trong hướng dẫn dành cho người mới bắt đầu này không được đánh số hoặc đánh dấu đầu dòng. Phần hướng dẫn từng bước kèm theo ảnh chụp màn hình ở cuối mỗi bước sẽ giúp tăng khả năng người dùng bị cuốn hút vào hướng dẫn.
  • Mô tả chung về các khả năng: Phần này sẽ bao gồm tất cả các khía cạnh mà BRL-CAD có khả năng thể hiện các kỳ quan. Cách tiếp cận sơ đồ sẽ là cách hiệu quả hơn để thu hút sự chú ý đối với phần này.
  • Nguyên tắc lập mô hình của BRL-CAD: Phần này sẽ cần được giải thích thêm vì người dùng có thể hiểu rõ hơn về BRL-CAD sau khi họ hiểu rõ các nguyên tắc lập mô hình này.
  • Cách sử dụng cơ bản các công cụ chính: Trong phần này, chúng tôi sẽ có hướng dẫn riêng về các công cụ chính và cách sử dụng cơ bản. Đây sẽ là các hướng dẫn từng bước.
  • Xuất/Nhập: Người dùng sẽ làm quen với Thư viện Chuyển đổi Hình học. Một trong những công dụng phổ biến nhất của BRL-CAD là chuyển đổi hình học từ định dạng này sang định dạng khác. Trong phần này, chúng tôi thảo luận về công cụ chuyển đổi xuất và nhập.
  • Kết xuất: Chúng tôi sẽ đề cập đến thông tin cơ bản về kết xuất hình ảnh và sự cần thiết của kết xuất trong phần mềm. Người dùng cũng sẽ biết cách kết xuất hình ảnh bằng BRL-CAD.

Ngoài ra, chúng tôi cũng tập trung vào những điểm sau:

  • Phần đầu của tài liệu sẽ trình bày thông tin cơ bản về phần mềm này.
  • Cách người dùng có thể kết nối với cộng đồng nguồn mở này; liên kết tới cuộc trò chuyện zulip BRL-CAD.
  • Ở cấp độ trừu tượng, hãy tạo tài liệu một chút hài hước và đề nghị người dùng mới đừng ngại nhìn thấy những từ lớn. Tôi thích cách tiếp cận thể hiện sự đồng cảm được sử dụng trên trang chính của BRL-CAD wiki.
  • Trang này sẽ có ảnh chụp màn hình về một số điều tuyệt vời mà người dùng có thể thực hiện khi sử dụng phần mềm này.

Mốc quan trọng

Tháng 7 (Giai đoạn xem xét đề xuất)

  • Tôi sẽ tự làm quen với phần mềm và tài liệu wiki của phần mềm đó trong khi xem qua các hướng dẫn hiện có.
  • Tôi sẽ cải thiện các tài liệu hiện có.

1/8 – 7/8 (Gắn kết cộng đồng)

  • Thảo luận với cố vấn về dự án.
  • Tinh chỉnh chi tiết dự án.
  • Thực hiện thay đổi cần thiết cho các mốc quan trọng (nếu cần).

8/8 – 14/8

  • Làm quen với tệp XML của Tài liệu

15/8 – 21/8

  • Viết tài liệu cho bài viết "Giới thiệu cơ bản về BRL-CAD"
  • Viết hướng dẫn từng bước cho bài viết "Cài đặt cơ bản"

22/8 – 27/8

  • Khám phá các khả năng khác nhau của BRL-CAD và liệt kê chúng cùng với ảnh chụp màn hình.
  • Giải thích các tính năng riêng lẻ trên một trang riêng.

Ngày 28 tháng 8 – ngày 3 tháng 9

  • Tiếp tục làm việc trên từng tài liệu để sử dụng các tính năng.

Ngày 4 tháng 9 – ngày 10 tháng 9

  • Tìm hiểu nguyên tắc lập mô hình.
  • Giải thích tất cả nguyên tắc lập mô hình.

Ngày 11 tháng 9 – ngày 17 tháng 9

  • Tìm hiểu cách sử dụng cơ bản các công cụ chính.
  • Liệt kê các ý tưởng để ghi lại cách sử dụng cơ bản của mỗi công cụ.

Ngày 18 tháng 9 – ngày 24 tháng 9

  • Ghi lại cách sử dụng từng công cụ.

Ngày 25 tháng 9 – ngày 1 tháng 10

  • Xây dựng mô hình để tạo mô hình chắc chắn cho hướng dẫn và viết bản nháp kèm theo.

Ngày 2 tháng 10 – ngày 8 tháng 10

  • Cải thiện bản nháp của mô hình.

Ngày 2 tháng 10 – ngày 8 tháng 10

  • Nghiên cứu những người chuyển đổi xuất khẩu và nhập khẩu.

Ngày 9 tháng 10 – ngày 15 tháng 10

  • Chuẩn bị xuất và nhập tài liệu.
  • Bắt đầu làm việc với việc kết xuất.

Ngày 16 tháng 10 – ngày 22 tháng 10

  • Ghi lại hướng dẫn kết xuất hình ảnh.

Ngày 23 tháng 10 – ngày 29 tháng 10

  • Đang xem lại tất cả tài liệu.

Ngày 30 tháng 10 – ngày 5 tháng 11

  • Xử lý tệp XML của Tài liệu

Ngày 6 tháng 11 – ngày 12 tháng 11

  • Xin ý kiến đánh giá của người cố vấn và các thành viên khác trong cộng đồng rồi tìm cách thay đổi.
  • Thảo luận với người cố vấn và thực hiện những thay đổi cuối cùng.

Ngày 12 tháng 11 - ngày 22 tháng 11

  • Quá trình thảo luận và thay đổi.
  • Chỉnh sửa tài liệu.

Giới thiệu bản thân

Tôi đã viết từ những ngày còn đi học. Tôi đi học về và viết tất cả về ngày của mình; điều gì khiến cho ngày của tôi trở nên tốt hơn hoặc tệ hơn. Tôi luôn muốn viết ra những lỗi mình đã mắc phải và làm cách nào để cải thiện chúng.

Trong quá trình đào tạo với tư cách là một nhà thiết kế web, chúng tôi được yêu cầu viết ra những gì chúng tôi học được hằng ngày. Tôi sẽ ghi lại một số vấn đề tôi đã gặp phải và giải pháp cho vấn đề đó.

Là người, tôi luôn hết lòng giúp đỡ người khác. Trong thời gian đi học và học đại học, tôi thường giải thích một số chủ đề cho bạn bè sau khi tự mình hiểu rõ những chủ đề đó. Tham gia GSoD là một bước đi tuyệt vời mà với tư cách là một người viết, tôi có thể đóng góp vào việc làm cho cộng đồng nguồn mở này trở nên hấp dẫn và hữu ích hơn cho người dùng mới trên toàn thế giới.