Cách Viết Tài Liệu Hướng Dẫn Sử Dụng Phần Mềm

  -  

Xác định lý do sale mang lại tư liệu của chúng ta.quý khách hàng vẫn xem: Tài liệu hướng dẫn áp dụng phần mềm

 Mặc cho dù lý do công dụng của ứng dụng là sẽ giúp đỡ người tiêu dùng hiểu cách áp dụng áp dụng, tuy vậy cũng có thể có hồ hết lý do không giống, ví dụ như cung cấp tiếp thị phần mềm, nâng cấp hình hình họa đơn vị cùng xứng đáng chú ý duy nhất là giảm chi phí cung cấp kỹ thuật. Trong một vài ngôi trường thích hợp, tài liệu là cần thiết để tuân thủ các qui định một mực hoặc các đề nghị pháp luật khác.

Bạn đang xem: Cách viết tài liệu hướng dẫn sử dụng phần mềm

Tuy nhiên, trong phần đông ngôi trường vừa lòng, tài liệu ứng dụng không nên sửa chữa mang lại kiến tạo đồ họa kỉm. Nếu một màn hình vận dụng trải đời hàng loạt tài liệu nhằm lý giải nó, tốt rộng không còn chúng ta nên biến hóa xây cất screen thành một thiết bị nào đấy trực quan lại rộng.

Hiểu người theo dõi mà lại ai đang viết tư liệu mang lại họ. Trong đa số các trường phù hợp, người tiêu dùng phần mềm tất cả không nhiều loài kiến ​​thức về máy vi tính xung quanh những tác vụ cơ mà áp dụng bọn họ thực hiện có thể chấp nhận được chúng ta tiến hành. Có một số phương pháp để xác định bí quyết giải quyết nhu yếu của mình bởi tài liệu của chúng ta.

Nhìn vào chức vụ công việc cơ mà người dùng tiềm năng của doanh nghiệp đã sở hữu. Quản trị viên khối hệ thống hoàn toàn có thể là chuyên gia về một số trong những vận dụng ứng dụng, trong những khi nhân viên cấp dưới nhập dữ liệu có khá nhiều tài năng chỉ biết ứng dụng mà họ hiện đang thực hiện nhằm nhập tài liệu. Quý Khách đề xuất lên ý tưởng viết từ bỏ toàn diện mang lại chi tiết, theo từng flows ứng với từng sứ mệnh người dùng. Thí dụ nlỗi sau:
*

Nhìn vào bao gồm người tiêu dùng. Mặc mặc dù chức vụ quá trình thường đã cho thấy phần nhiều gì những fan làm cho, mà lại rất có thể bao gồm sự biệt lập đáng chú ý về kiểu cách áp dụng một số chức danh cố định vào một đội nhóm chức nhất định. Bằng bí quyết phỏng vấn số đông người dùng tiềm năng, chúng ta cũng có thể biết được liệu tuyệt hảo của người sử dụng về phần lớn gì chức vụ công việc của mình đã cho thấy bao gồm đúng đắn hay không.Xem tài liệu hiện nay bao gồm. Tài liệu cho các phiên bạn dạng trước của phần mềm, tương tự như những thông số kỹ thuật nghệ thuật công dụng, cung ứng một số trong những hướng dẫn về đa số gì người tiêu dùng cần phải biết để sử dụng công tác. Tuy nhiên, hãy nhớ là người tiêu dùng cuối không quan tâm mang đến biện pháp hoạt động vui chơi của chương trình nhưng bọn chúng hoàn toàn có thể làm được gì đến chúng ta.Xác định các nhiệm vụ đề xuất thiết để triển khai các bước, cùng mọi trách nhiệm làm sao cần phải triển khai trước lúc hoàn toàn có thể thực hiện được những trách nhiệm đó.


*

 Tài liệu phần mềm rất có thể được cấu trúc theo một trong các 2 format, tư liệu tham khảo với trả lời áp dụng. Thông thường, phối hợp các định dạng là biện pháp tiếp cận tốt nhất.Định dạng khuyên bảo tìm hiểu thêm được dành nhằm phân tích và lý giải các anh tài chưa có người yêu của một ứng dụng ứng dụng (nút, tab, trường và hộp thoại) cùng cách chúng hoạt động. hầu hết file giúp sức được viết ở kiểu định dạng đó, đặc biệt là hỗ trợ theo ngữ chình ảnh hiển thị chủ đề tất cả tương quan bất cứ bao giờ người tiêu dùng nhấp vào nút ít Trợ góp bên trên một màn hình hiển thị ví dụ.Định dạng gợi ý thực hiện giải thích biện pháp áp dụng phần mềm để tiến hành một tác vụ ví dụ. Hướng dẫn thực hiện thường được định hình dưới dạng giải đáp in hoặc PDF, mặc dù một số trong những file trợ giúp bao gồm các chủ đề về phong thái tiến hành các tác vụ rõ ràng. (Các chủ đề trợ giúp này thường ko nhạy bén với ngữ chình ảnh, tuy nhiên chúng có thể được cực kỳ liên kết đến từ những chủ đề đó).

Quyết định (các) dạng tư liệu sẽ có được.

Xem thêm: Cách Ẩn Số Người Theo Dõi Trên Facebook 2021, 3 Cách Ẩn Follow Trên Facebook Nhanh Chóng 2021

 Tài liệu phần mềm dành riêng cho tất cả những người sử dụng cuối có thể có một hoặc các dạng: sách chỉ dẫn in, tài liệu PDF, file giúp sức hoặc trợ giúp trực tuyến. Mỗi biểu chủng loại được thiết kế với để chỉ cho những người sử dụng biện pháp thực hiện từng chức năng của lịch trình, mặc dù làm việc dạng hướng dẫn tuyệt phía dẫn; vào trường đúng theo file hỗ trợ và hỗ trợ trực đường, điều này rất có thể bao hàm video diễn đạt cũng như vnạp năng lượng bản và hình ảnh tĩnh.

Các file hỗ trợ và hỗ trợ trực tuyến đường đề nghị được lập chỉ mục cùng có thể tìm tìm trường đoản cú khóa nhằm có thể chấp nhận được người tiêu dùng gấp rút tra cứu thấy thông báo họ đang search kiếm. Mặc mặc dù các dụng cụ chế tạo file giúp đỡ rất có thể tự động tạo chỉ mục, cơ mà thường tốt rộng là chế tạo ra chỉ mục Theo phong cách thủ công bằng tay, sử dụng các thuật ngữ mà người dùng rất có thể tìm kiếm tìm.

Chọn mức sử dụng tư liệu tương thích. Hướng dẫn áp dụng bản in hoặc PDF có thể được viết bởi lịch trình giải pháp xử lý văn bản nhỏng Word hoặc trình soạn thảo văn uống bản tinh vi nlỗi FrameMaker, tùy trực thuộc vào độ dài cùng độ phức hợp của chúng. File trợ giúp có thể được viết bởi cơ chế tạo ra hỗ trợ nlỗi RoboHelp, Help cùng Manual, Doc-To-Help, Flare, HelpLogix hoặc HelpServer.

Câu hỏi với câu trả lời của cộng đồng

Có ngẫu nhiên luật miễn tầm giá nào cho tài liệu ứng dụng không?Hãy test Doxygene để tạo nên các trang chỉ dẫn dạng Web. Ngoài ra bạn cũng có thể sử dụng LaTeX để xuất ra file PDF.Tôi đã thấy các lần nhận phím được khắc ghi ngơi nghỉ những định dạng. Có một tiêu chuẩn thực tế cho những món đồ tốt toàn bộ chúng phần lớn không giống nhau?Không gồm tiêu chuẩn chỉnh chung; tuy vậy, chúng ta nên được sắp xếp tiêu chuẩn chỉnh cho những tài liệu của riêng bản thân. Để tất cả một vài phát minh, hãy coi Hướng dẫn chế tạo vẻ bên ngoài của Microsoft (gồm sẵn bên trên Amazon) và Hướng dẫn loại của Apple (https://help.hãng apple.com/applestyleguide). Chúng tất cả các phong thái không giống nhau, vị vậy nếu bạn viết tài liệu nhiều nền tảng gốc rễ, bạn cũng có thể áp dụng một số trong những nguyên tố từ gợi ý này với một số trong những nguyên tố trường đoản cú chỉ dẫn khác.

Lời khuyên

Thí dụ: Bạn có thể ghnghiền, chế hình họa cùng tạo những cảm giác dựa vào pháp luật SnagIt - một hình thức đơn giản và dễ dàng, tinch gọn dành riêng cho nhóm UI/UX designer nghiệp dư.

*

Giai điệu đặc biệt đặc trưng, đặc biệt là khi viết tư liệu phần mềm cho người cần sử dụng cuối. Địa chỉ người dùng bởi ngôi máy nhì là "bạn" cố gắng vày "người dùng" của ngôi trang bị bố.

Xem thêm: Hướng Dẫn Cách Làm Rau Câu 3D Đơn Giản Nhất

 

Những khí cụ bắt buộc mang lại hỗ trợ viết tài liệu

Công vắt thiết kế phần mềm: MS Word, Google Doc...Tài liệu Template chuẩn chỉnh, thường là tài liệu mẫu tự các dự án cũ của người tiêu dùng.Công nuốm sinh sản hình ảnh chụp màn hình, thí dụ: SnagIt.