Biên Soạn bản Hướng Dẫn Sử Dụng -- Editing the Manual¶
Bạn có thể sửa đổi bản Hướng Dẫn Sử Dụng bằng việc soạn thảo các văn bản địa phương. Những tập tin này sẽ được đồng bộ hóa với các bản ở trên mạng thông qua một kho lưu trữ. Dựa vào phương pháp này, máy chủ sẽ cập nhật bản hướng dẫn sử dụng trên mạng.
The manual is written in the reStructuredText (RST) markup language and can be edited using a plain text editor. For a local preview, you convert (build) the manual source files from RST into HTML web pages.
Cập Nhật -- Update¶
Trước tiên, hãy đảm bảo rằng bản sao địa phương của bản Hướng Dẫn Sử Dụng của bạn đã được cập nhật với những thay đổi gần đây nhất từ kho lưu trữ trực tuyến bằng cách sử dụng:
svn update
Viết Tài Liệu -- Writing¶
Bây giờ, bạn có thể chỉnh sửa các tập tin tài liệu, tức là các tập tin .rst
bên trong thư mục 'manual' bằng cách sử dụng trình soạn thảo văn bản lựa chọn của mình.
Hãy đọc bản Hướng Dẫn về Phong Cách Viết -- Writing Style Guide để biết được các quy ước và Hướng Dẫn về Kiểu Cách của Dấu Đánh -- Markup Style Guide để tìm hiểu cách viết bằng ngôn ngữ đánh dấu tái cấu trúc văn bản.
Chúc bạn viết vui vẻ!
Những Thay Đổi Lớn Hơn -- Bigger Changes¶
Nếu bạn định cho thêm hoặc định trùng tu một phần nào đó của bản hướng dẫn, thì xin hãy nhớ kiểm tra cẩn thận, xem rằng phần đó chưa có ai viết cả. Ở một số nơi, các tài liệu không được tổ chức nghiêm ngặt, đến nỗi các phần có thể bị trùng lặp, hoặc nằm ở một vị trí bất thường. Trong trường hợp bạn tìm thấy một phần nào đó trùng lặp nhau, hoặc phần đó nằm không đúng chỗ của nó, thì xin hãy tạo một tác vụ -- create a task để giải thích vấn đề, và, nếu có thể, cho kèm vào đó bản sửa đổi (những thay đổi thực) mà mình đã viết nữa.
Trước khi bạn thực hiện bất kỳ một sự chỉnh sửa khá phức tạp và khó lý giải nào (ví dụ: di chuyển các thư mục từ chỗ nọ sang chỗ kia), thì bạn nên kiểm tra và xác minh các thay đổi của mình với một người bảo trì bản hướng dẫn sử dụng trước đi đã, xem xem sự đóng góp của bạn có đi đôi với đường lối của cộng đồng trong bản hướng dẫn hay không. Điều này sẽ đảm bảo sự tận dụng tốt nhất thời gian và lòng tốt của bạn, vì nếu không, rất có thể vì một số lý do nào đó, những thay đổi của bạn sẽ gây xung đột với bản hiện tại và hoặc là bị từ chối, hoặc là cần phải tốn kém thời gian để xem xét lại. Ví dụ, một người khác có thể đã làm việc trên phần mà bạn muốn thay đổi, hoặc phần này có thể đã được lên kế hoạch để xóa hoặc đi hoặc để cập nhật theo một kế hoạch đã được Blender đặt ra trước đây, chẳng hạn.
Sự Liên lạc -- Communicating sớm và thường xuyên là chìa khóa để có một môi trường sản xuất hiệu quả, hòng tránh lãng phí nỗ lực của mọi người và hòng đạt được một bản hướng dẫn sử dụng Blender tốt hơn.
Yêu Cầu Giúp Đỡ/Trả lời -- Getting Help/Answers¶
Nếu bạn có nghi ngờ gì về một chức năng nào mà bạn muốn viết tài liệu về nó, thì bạn nên đặt câu hỏi của mình với các nhà phát triển Blender chịu trách nhiệm cho khu vực đó, hoặc đặt câu hỏi trên kênh hỗ trợ người dùng không chuyên tại #docs
hoặc #blender-coders
, dùng kênh Trò Chuyện Trực Tuyến Về Blender -- Blender Chat.
Bản thân Blender cũng có một hệ thống các nhân viên chịu trách nhiệm về các mô-đun, gồm có các nhân viên phát triển phần mềm và các nghệ sĩ thành viên chịu trách nhiệm thiết kế và bảo trì các bộ phận của Blender mà họ được chỉ định. Xin xem trang Nhân viên chịu trách nhiệm về các mô-đun -- module owners page để biết thêm thông tin.
Duyệt Thảo -- Preview¶
Xin hãy biên tập và tạo bản hướng dẫn sử dụng để duyệt thảo các thay đổi của bạn như đã được hướng dẫn -- as instructed. Hãy nhớ rằng bạn còn có thể chỉ biên tập riêng một chương mà bạn vừa chỉnh sửa mà thôi, để duyệt thảo nó một cách nhanh chóng. Mở các tập tin .html
được tạo trong thư mục build/html
dùng trình duyệt trang mạng của mình, hoặc làm tươi lại trang đang xem nếu bạn đã mở nó rồi.
Tải Các Thay Đổi Lên -- Upload¶
Khi bạn đã hài lòng với các thay đổi của mình, bạn có thể tải chúng lên, để chúng hiện hữu trong bản hướng dẫn trực tuyến. Thực hiện điều này bằng cách, trước tiên, gửi các bản chỉ chứa các thay đổi, hòng dùng nó để chắp vá bản hiện tại, để một người nào đó có thể xét duyệt các thay đổi, và phản hồi ý kiến của họ đối với những sửa chữa của bạn. Sau đó, bạn có thể trực tiếp chuyển giao các thay đổi của mình vào kho chứa. Quá trình này sẽ được mô tả chi tiết trong phần tiếp theo.