Cách viết hướng dẫn sử dụng

Bạn rất có thể sửa thay đổi bản Hướng Dẫn Sử Dụng bởi Việc soạn thảo các văn bạn dạng địa phương thơm. Những tập tin này sẽ được đồng hóa hóa với những bản sinh sống bên trên mạng thông sang 1 kho lưu trữ. Dựa vào phương thức này, sever sẽ cập nhật bạn dạng hướng dẫn sử dụng bên trên mạng.

Bạn đang xem: Cách viết hướng dẫn sử dụng

The manual is written in the reStructuredText(RST) markup language & can be edited using a plain text editor.For a local pnhận xét, you convert (build) the manual source files from RST inlớn HTML web pages.


Cập Nhật -- Update¶

Trước tiên, hãy bảo vệ rằng phiên bản sao địa phương của phiên bản Hướng Dẫn Sử Dụng của chúng ta đã làm được update cùng với đều đổi khác vừa mới đây nhất trường đoản cú kho tàng trữ trực con đường bằng cách sử dụng:


Viết Tài Liệu -- Writing¶

Bây tiếng, bạn cũng có thể sửa đổi các tập tin tài liệu, tức là những tập tin .rst bên phía trong thư mục "manual" bằng phương pháp áp dụng trình biên soạn thảo vnạp năng lượng bạn dạng lựa chọn của bản thân.

Hãy đọc bản Hướng Dẫn về Phong Cách Viết -- Writing Style Guide để hiểu rằng các quy ước với Hướng Dẫn về Kiểu Cách của Dấu Đánh -- Markup Style Guide nhằm tò mò biện pháp viết bởi ngôn từ khắc ghi tái cấu trúc văn uống bạn dạng.

Chúc các bạn viết vui vẻ!


Những Tgiỏi Đổi Lớn Hơn -- Bigger Changes¶

Nếu các bạn định cho thêm hoặc định trùng tu 1 phần như thế nào kia của bạn dạng hướng dẫn, thì xin hãy lưu giữ bình chọn cẩn trọng, coi rằng phần kia chưa xuất hiện ai viết cả. Tại một số nơi, các tài liệu không được tổ chức nghiêm ngặt, đến nỗi những phần rất có thể bị giống nhau, hoặc ở tại một vị trí không bình thường. Trong ngôi trường phù hợp các bạn tra cứu thấy một phần làm sao đó đụng hàng nhau, hoặc phần đó nằm không ổn vị trí của nó, thì xin hãy chế tạo ra một tác vụ -- create a task nhằm giải thích vụ việc, với, giả dụ có thể, mang lại kèm vào kia bản sửa thay đổi (phần lớn biến hóa thực) cơ mà tôi đã viết nữa.

Trước khi chúng ta triển khai ngẫu nhiên một sự sửa đổi khá phức hợp với khó phân tích và lý giải như thế nào (ví dụ: dịch chuyển những thư mục trường đoản cú vị trí nọ sang chỗ kia), thì bạn nên soát sổ và xác minh các biến đổi của bản thân với 1 bạn duy trì bản trả lời sử dụng trước đi sẽ, xem coi sự góp sức của bạn bao gồm song song với đường lối của xã hội trong bạn dạng gợi ý hay là không. Điều này đã bảo đảm an toàn sự tận dụng tối đa tốt nhất có thể thời hạn cùng lòng tốt của chúng ta, vì chưng nếu không, rất hoàn toàn có thể vì chưng một vài nguyên do như thế nào kia, rất nhiều biến đổi của bạn sẽ gây xung đột cùng với phiên bản bây giờ cùng Hoặc là bị từ chối, Hay những cần phải tốn kém nhẹm thời hạn nhằm để mắt tới lại. lấy ví dụ như, một người không giống có thể vẫn làm việc trên phần cơ mà bạn có nhu cầu biến đổi, hoặc phần này có thể đã có lên chiến lược nhằm xóa hoặc di chuyển hoặc để update theo một chiến lược đã làm được opdaichien.com đề ra trước đây, chẳng hạn.

Xem thêm: "Kinh Tế Quốc Dân Là Gì ? Nghĩa Của Từ Kinh Tế Quốc Dân Trong Tiếng Việt

Sự Liên lạc -- Communicating nhanh chóng và thường xuyên là khóa xe để sở hữu một môi trường xung quanh sản xuất công dụng, hòng tách lãng phí cố gắng của số đông bạn cùng hòng đã có được một bản gợi ý áp dụng opdaichien.com tốt hơn.


Yêu Cầu Giúp Đỡ/Trả lời -- Getting Help/Answers¶

Nếu bạn có nghi ngại gì về một tác dụng làm sao nhưng bạn muốn viết tài liệu về nó, thì bạn nên đặt thắc mắc của mình cùng với những công ty cải cách và phát triển opdaichien.com Chịu trách nát nhiệm mang đến khoanh vùng kia, hoặc đặt câu hỏi bên trên kênh cung cấp người dùng không chăm tại #opdaichien.com hoặc #opdaichien.com-coders, sử dụng kênh Trò Cthị trấn Trực Tuyến Về opdaichien.com -- opdaichien.com Chat.

Bản thân opdaichien.com cũng có một hệ thống những nhân viên cấp dưới chịu đựng trách nát nhiệm về những mô-đun, tất cả gồm các nhân viên cấp dưới trở nên tân tiến phần mềm cùng các nghệ sĩ thành viên chịu trách rưới nhiệm thi công cùng duy trì những bộ phận của opdaichien.com mà người ta được chỉ định và hướng dẫn. Xin coi trang Nhân viên chịu đựng trách nhiệm về những mô-đun -- module owners page nhằm hiểu thêm báo cáo.


Duyệt Thảo -- Preview¶

Xin hãy chỉnh sửa cùng chế tạo bản chỉ dẫn áp dụng để coi sóc thảo các chuyển đổi của người sử dụng như đã làm được giải đáp -- as instructed. Hãy nhớ là chúng ta còn rất có thể chỉ biên tập riêng biệt một cmùi hương cơ mà các bạn vừa chỉnh sửa cơ mà thôi, nhằm để ý thảo nó một giải pháp nhanh chóng. Mlàm việc các tập tin .html được chế tác trong tlỗi mục build/html dùng trình để mắt tới trang mạng của bản thân, hoặc làm tươi lại trang đã xem nếu như bạn đã mngơi nghỉ nó rồi.

Xem thêm: Sha256 Là Gì - Mức Độ An Toàn Sha256


Tải Các Tgiỏi Đổi Lên -- Upload¶

khi chúng ta vẫn ăn nhập cùng với các thay đổi của bản thân, bạn có thể sở hữu bọn chúng lên, để bọn chúng hiện lên vào phiên bản lý giải trực con đường. Thực hiện nay điều này bằng cách, trước tiên, gửi các bạn dạng chỉ đựng những thay đổi, hòng dùng nó để chắp vá bản bây chừ, nhằm một người nào đó hoàn toàn có thể xét chăm sóc các biến đổi, và bình luận ý kiến của mình đối với phần nhiều sửa chữa thay thế của người sử dụng. Sau đó, chúng ta có thể thẳng bàn giao các biến hóa của chính bản thân mình vào kho chứa. Quá trình này sẽ tiến hành mô tả chi tiết vào phần tiếp sau.



Chuyên mục: Kiến Thức