Viết tài liệu hướng dẫn sử dụng phần mềm

Xác định nguyên do kinh doanh mang đến tư liệu của người tiêu dùng.

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

 Mặc mặc dù nguyên do tác dụng của ứng dụng là để giúp đỡ người dùng đọc bí quyết sử dụng ứng dụng, nhưng cũng có thể có hầu hết nguyên do khác, chẳng hạn như cung ứng tiếp thị ứng dụng, nâng cao hình hình họa công ty và đáng để ý độc nhất vô nhị là bớt chi phí cung ứng kỹ thuật. Trong một vài trường vừa lòng, tài liệu là cần thiết nhằm vâng lệnh những luật nhất mực hoặc các đề xuất pháp luật không giống.

Tuy nhiên, vào hầu như trường thích hợp, tư liệu ứng dụng không nên sửa chữa mang đến xây cất giao diện kỉm. Nếu một màn hình hiển thị vận dụng những hiểu biết 1 loạt tài liệu nhằm lý giải nó, xuất sắc rộng không còn chúng ta nên thay đổi xây cất màn hình hiển thị thành một trang bị nào đấy trực quan hơn.

Hiểu khán giả nhưng bạn đang viết tài liệu cho bọn họ. Trong hầu như các ngôi trường hợp, người tiêu dùng ứng dụng gồm ít kiến ​​thức về máy tính kế bên các tác vụ nhưng mà ứng dụng họ sử dụng chất nhận được chúng ta thực hiện. Có một trong những cách để khẳng định cách giải quyết yêu cầu của họ bởi tài liệu của khách hàng.

Nhìn vào chức vụ công việc nhưng mà người tiêu dùng tiềm năng của chúng ta vẫn nắm giữ. Quản trị viên khối hệ thống có thể là chuyên gia về một số trong những ứng dụng ứng dụng, trong những lúc nhân viên nhập dữ liệu có rất nhiều kĩ năng chỉ biết vận dụng mà họ hiện tại đang sử dụng để nhập tài liệu. quý khách đề xuất lên ý tưởng viết từ toàn diện và tổng thể đến chi tiết, theo từng flows ứng cùng với từng sứ mệnh người dùng. Thí dụ nlỗi sau:
*
Nhìn vào thiết yếu người tiêu dùng. Mặc cho dù chức danh công việc thường xuyên chỉ ra các gì phần đa bạn làm, cơ mà hoàn toàn có thể bao gồm sự khác hoàn toàn đáng chú ý về cách sử dụng một số chức vụ cố định vào một tổ chức một mực. Bằng bí quyết phỏng vấn hồ hết người dùng tiềm năng, bạn cũng có thể biết được liệu tuyệt hảo của doanh nghiệp về hồ hết gì chức danh quá trình của mình đã cho thấy có chính xác hay không.Xem tài liệu hiện nay bao gồm. Tài liệu cho những phiên phiên bản trước của phần mềm, cũng như những thông số nghệ thuật chức năng, hỗ trợ một số trong những chỉ dẫn về phần lớn gì người dùng cần phải biết nhằm thực hiện chương trình. Tuy nhiên, hãy hãy nhờ rằng người dùng cuối không quan tâm cho biện pháp hoạt động vui chơi của chương trình cơ mà bọn chúng hoàn toàn có thể làm được gì đến họ.Xác định các nhiệm vụ buộc phải thiết để tiến hành các bước, và phần lớn nhiệm vụ làm sao rất cần phải thực hiện trước khi có thể tiến hành được mọi nhiệm vụ kia.

*

Xác định (các) định dạng thích hợp đến tư liệu.

Xem thêm: Hướng Dẫn Cài Đặt Camera Quan Sát Xem Qua Mạng Internet, Hướng Dẫn Cài Đặt Camera Xem Qua Mạng Internet

 Tài liệu phần mềm rất có thể được kết cấu theo một trong những 2 format, tư liệu tìm hiểu thêm và gợi ý áp dụng. Thông thường, kết hợp các định dạng là giải pháp tiếp cận rất tốt.

Định dạng lí giải tìm hiểu thêm được dành riêng nhằm lý giải các thiên tài trơ tráo của một áp dụng phần mềm (nút ít, tab, ngôi trường và vỏ hộp thoại) và cách chúng hoạt động. Nhiều file hỗ trợ được viết sinh hoạt định dạng này, nhất là hỗ trợ theo ngữ chình ảnh hiển thị chủ thể bao gồm liên quan bất cứ bao giờ người dùng nhấp vào nút Trợ giúp bên trên một screen rõ ràng.Định dạng giải đáp áp dụng phân tích và lý giải cách sử dụng ứng dụng nhằm tiến hành một tác vụ rõ ràng. Hướng dẫn thực hiện thường xuyên được định hình dưới dạng giải đáp in hoặc PDF, mặc dù một trong những file giúp đỡ bao gồm các chủ đề về kiểu cách triển khai các tác vụ rõ ràng. (Các chủ thể hỗ trợ này hay không nhạy cảm với ngữ chình ảnh, tuy vậy chúng hoàn toàn có thể được siêu liên kết đến từ những chủ đề đó).  

Quyết định (các) dạng tư liệu sẽ có. Tài liệu phần mềm dành cho những người cần sử dụng cuối rất có thể có 1 hoặc các dạng: sách chỉ dẫn in, tài liệu PDF, file trợ giúp hoặc giúp sức trực con đường. Mỗi biểu mẫu có phong cách thiết kế nhằm chỉ cho tất cả những người cần sử dụng bí quyết thực hiện từng công dụng của lịch trình, mặc dầu nghỉ ngơi dạng gợi ý tuyệt hướng dẫn; vào trường hợp file hỗ trợ cùng giúp sức trực con đường, vấn đề đó có thể bao gồm Clip diễn đạt cũng tương tự vnạp năng lượng phiên bản và hình ảnh tĩnh.

Các file giúp đỡ và hỗ trợ trực tuyến đường đề nghị được lập chỉ mục và rất có thể kiếm tìm kiếm từ bỏ khóa để chất nhận được người dùng mau lẹ search thấy ban bố chúng ta đang tìm kiếm kiếm. Mặc mặc dù những điều khoản tạo nên file trợ giúp có thể tự động hóa tạo nên chỉ mục, mà lại hay giỏi rộng là tạo nên chỉ mục theo cách thủ công bằng tay, thực hiện các thuật ngữ mà lại người tiêu dùng có thể tra cứu tìm.

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

Câu hỏi và câu vấn đáp của cộng đồng

Có bất kỳ công cụ miễn phí nào cho tư liệu phần mềm không?Hãy demo Doxygen để tạo ra các trang lí giải dạng Web. Bên cạnh đó chúng ta có thể sử dụng LaTeX để xuất ra file PDF.Tôi đang thấy những lần dấn phím được đánh dấu ở nhiều format. Có một tiêu chuẩn chỉnh thực tế cho các món đồ tuyệt tất cả bọn chúng gần như không giống nhau?Không bao gồm tiêu chuẩn chung; mặc dù, các bạn nên được đặt tiêu chuẩn chỉnh cho những tài liệu của riêng mình. Để có một vài phát minh, hãy xem Hướng dẫn tạo ra kiểu dáng của Microsoft (bao gồm sẵn trên Amazon) cùng Hướng dẫn giao diện của Apple (https://help.apple.com/applestyleguide). Chúng gồm những phong thái khác nhau, vì vậy nếu khách hàng viết tư liệu nhiều căn nguyên, chúng ta có thể sử dụng một số nhân tố trường đoản cú khuyên bảo này và một số nhân tố từ bỏ lí giải không giống.

Lời khuyên

Thí dụ: Bạn rất có thể ghnghiền, chế ảnh và chế tác các hiệu ứng dựa vào hiện tượng SnagIt - một phương tiện đơn giản, tinh gọn gàng dành cho nhóm UI/UX designer nghiệp dư.

Xem thêm: Bộ 19 Video Hướng Dẫn Sử Dụng Phần Mềm G8 2021, Video Hướng Dẫn Sử Dụng Phần Mềm Dự Toán G8 Mới

*

Giai điệu đặc trưng đặc biệt quan trọng, đặc biệt là lúc viết tư liệu ứng dụng cho tất cả những người sử dụng cuối. Địa chỉ người dùng bằng ngôi trang bị hai là "bạn" rứa do "bạn dùng" của ngôi thiết bị bố.

 

Những phương pháp đề nghị đến cung ứng 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, thường xuyên là tư liệu mẫu mã từ bỏ những dự án công trình cũ của bạn.Công núm tạo ảnh chụp màn hình hiển thị, thí dụ: SnagIt.
Chuyên mục: Hướng Dẫn - Hỏi Đáp