Xác định lý do kinh doanh cho tài liệu của bạn.Bạn đang xem : Mẫu tài liệu hướng dẫn sử dụng phần mềm Mặc dù lý do chức năng của phần mềm là để giúp người dùng hiểu cách sử dụng ứng dụng, nhưng cũng có những lý do khác, chẳng hạn như hỗ trợ tiếp thị phần mềm, nâng cao hình ảnh công ty và đáng chú ý nhất là giảm chi phí hỗ trợ kỹ thuật. Trong một số trường hợp, tài liệu là cần thiết để tuân thủ các quy định nhất định hoặc các yêu cầu pháp lý khác.

Tuy nhiên, trong mọi trường hợp, tài liệu phần mềm không nên thay thế sửa chữa cho phong cách thiết kế giao diện kém. Nếu một màn hình hiển thị ứng dụng nhu yếu hàng loạt tài liệu để lý giải nó, tốt hơn hết bạn nên đổi khác phong cách thiết kế màn hình thành một thứ gì đó trực quan hơn .
Bạn đang đọc : Mẫu Tài Liệu Hướng Dẫn Sử Dụng Phần Mềm Quản Lý Văn Bản, Cách Viết Tài Liệu Hướng Dẫn Sử Dụng Phần Mềm

Hiểu khán giả mà bạn đang viết tài liệu cho họ. Trong hầu hết các trường hợp, người dùng phần mềm có ít kiến ​​thức về máy tính ngoài các tác vụ mà ứng dụng họ sử dụng cho phép họ thực hiện. Có một số cách để xác định cách giải quyết nhu cầu của họ bằng tài liệu của bạn.

Nhìn vào chức danh công việc mà người dùng tiềm năng của bạn đang nắm giữ. Quản trị viên hệ thống có thể là chuyên gia về một số ứng dụng phần mềm, trong khi nhân viên nhập dữ liệu có nhiều khả năng chỉ biết ứng dụng mà họ hiện đang sử dụng để nhập dữ liệu. Bạn nên lên ý tưởng viết từ tổng thể đến chi tiết, theo từng flows ứng với từng vai trò người dùng. Thí dụ như sau:

Nhìn vào chính người dùng. Mặc dù chức danh công việc thường chỉ ra những gì mọi người làm, nhưng có thể có sự khác biệt đáng kể về cách sử dụng một số chức danh nhất định trong một tổ chức nhất định. Bằng cách phỏng vấn những người dùng tiềm năng, bạn có thể biết được liệu ấn tượng của bạn về những gì chức danh công việc của họ chỉ ra có chính xác hay không.Xem tài liệu hiện có. Tài liệu cho các phiên bản trước của phần mềm, cũng như các thông số kỹ thuật chức năng, cung cấp một số chỉ dẫn về những gì người dùng cần biết để sử dụng chương trình. Tuy nhiên, hãy nhớ rằng người dùng cuối không quan tâm đến cách hoạt động của chương trình mà chúng có thể làm được gì cho họ.Xác định các nhiệm vụ cần thiết để thực hiện công việc, và những nhiệm vụ nào cần phải thực hiện trước khi có thể thực hiện được những nhiệm vụ đó.mà người dùng tiềm năng của bạn đang nắm giữ. Quản trị viên mạng lưới hệ thống hoàn toàn có thể là chuyên viên về một số ít ứng dụng phần mềm, trong khi nhân viên cấp dưới nhập tài liệu có nhiều năng lực chỉ biết ứng dụng mà họ hiện đang sử dụng để nhập tài liệu. Bạn nên lên ý tưởng sáng tạo viết từ tổng thể và toàn diện đến cụ thể, theo từng flows ứng với từng vai trò người dùng. Thí dụ như sau : Mặc dù chức vụ việc làm thường chỉ ra những gì mọi người làm, nhưng hoàn toàn có thể có sự độc lạ đáng kể về cách sử dụng một số ít chức vụ nhất định trong một tổ chức triển khai nhất định. Bằng cách phỏng vấn những người dùng tiềm năng, bạn hoàn toàn có thể biết được liệu ấn tượng của bạn về những gì chức vụ việc làm của họ chỉ ra có đúng chuẩn hay không. Tài liệu cho những phiên bản trước của phần mềm, cũng như những thông số kỹ thuật kỹ thuật công dụng, phân phối một số ít hướng dẫn về những gì người dùng cần biết để sử dụng chương trình. Tuy nhiên, hãy nhớ rằng người dùng cuối không chăm sóc đến cách hoạt động giải trí của chương trình mà chúng hoàn toàn có thể làm được gì cho họ. t để thực thi việc làm, và những trách nhiệm nào cần phải triển khai trước khi hoàn toàn có thể triển khai được những trách nhiệm đó .
Mặc dù chức vụ việc làm thường chỉ ra những gì mọi người làm, nhưng hoàn toàn có thể có sự độc lạ đáng kể về cách sử dụng một số ít chức vụ nhất định trong một tổ chức triển khai nhất định. Bằng cách phỏng vấn những người dùng tiềm năng, bạn hoàn toàn có thể biết được liệu ấn tượng của bạn về những gì chức vụ việc làm của họ chỉ ra có đúng mực hay không. Tài liệu cho các phiên bản trước của phần mềm, cũng như các thông số kỹ thuật kỹ thuật công dụng, cung ứng một số ít hướng dẫn về những gì người dùng cần biết để sử dụng chương trình. Tuy nhiên, hãy nhớ rằng người dùng cuối không chăm sóc đến cách hoạt động giải trí của chương trình mà chúng hoàn toàn có thể làm được gì cho họ. t để thực thi việc làm, và những trách nhiệm nào cần phải triển khai trước khi hoàn toàn có thể triển khai được những trách nhiệm đó. mà người dùng tiềm năng của bạn đang nắm giữ. Quản trị viên mạng lưới mạng lưới hệ thống trọn vẹn hoàn toàn có thể là nhân viên về 1 số ít ít ứng dụng phần mềm, trong khi nhân viên cấp dưới cấp dưới nhập tài liệu có nhiều năng lượng chỉ biết ứng dụng mà họ hiện đang sử dụng để nhập tài liệu. Bạn nên lên sáng tạo độc đáo phát minh sáng tạo viết từ tổng thể và toàn diện và tổng lực đến đơn cử, theo từng flows ứng với từng vai trò người dùng. Thí dụ như sau : Mặc dù chức vụ việc làm thường chỉ ra những gì mọi người làm, nhưng trọn vẹn hoàn toàn có thể có sự độc lạ đáng kể về cách sử dụng 1 số ít ít chức vụ nhất định trong một tổ chức triển khai tiến hành nhất định. Bằng cách phỏng vấn những người dùng tiềm năng, bạn trọn vẹn hoàn toàn có thể biết được liệu ấn tượng của bạn về những gì chức vụ việc làm của họ chỉ ra có đúng chuẩn hay không. Tài liệu cho những phiên bản trước của phần mềm, cũng như những thông số kỹ thuật kỹ thuật kỹ thuật tác dụng, phân phối một số ít ít hướng dẫn về những gì người dùng cần biết để sử dụng chương trình. Tuy nhiên, hãy nhớ rằng người dùng cuối không chăm nom đến cách hoạt động giải trí vui chơi của chương trình mà chúng trọn vẹn hoàn toàn có thể làm được gì cho họ. t để thực thi việc làm, và những nghĩa vụ và trách nhiệm nào cần phải tiến hành trước khi trọn vẹn hoàn toàn có thể tiến hành được những nghĩa vụ và trách nhiệm đó .

Xác định (các) định dạng thích hợp cho tài liệu.Xem thêm : Đánh Giá Honor 9 Lite : Chiếc điện thoại thông minh Dành Cho Tất Cả Mọi Người Tài liệu phần mềm có thể được cấu trúc theo 1 trong 2 định dạng, tài liệu tham khảo và hướng dẫn sử dụng. Đôi khi, kết hợp các định dạng là cách tiếp cận tốt nhất.

Định dạng hướng dẫn tìm hiểu thêm được dành để lý giải các tính năng riêng không liên quan gì đến nhau của một ứng dụng phần mềm ( nút, tab, trường và hộp thoại ) và cách chúng hoạt động giải trí. Nhiều file trợ giúp được viết ở định dạng này, đặc biệt quan trọng là trợ giúp theo ngữ cảnh hiển thị chủ đề có tương quan bất kỳ khi nào người dùng nhấp vào nút Trợ giúp trên một màn hình cụ thể. Định dạng hướng dẫn sử dụng lý giải cách sử dụng phần mềm để thực thi một tác vụ đơn cử. Hướng dẫn sử dụng thường được định dạng dưới dạng hướng dẫn in hoặc PDF, mặc dầu một số ít file trợ giúp gồm có các chủ đề về cách thực thi các tác vụ đơn cử. ( Các chủ đề trợ giúp này thường không nhạy cảm với ngữ cảnh, mặc dầu chúng hoàn toàn có thể được siêu link đến từ các chủ đề đó ) .
Định dạng hướng dẫn tìm hiểu thêm được dành để lý giải các tính năng riêng không liên quan gì đến nhau của một ứng dụng phần mềm ( nút, tab, trường và hộp thoại ) và cách chúng hoạt động giải trí. Nhiều file trợ giúp được viết ở định dạng này, đặc biệt quan trọng là trợ giúp theo ngữ cảnh hiển thị chủ đề có tương quan bất kể khi nào người dùng nhấp vào nút Trợ giúp trên một màn hình cụ thể. Định dạng hướng dẫn sử dụng lý giải cách sử dụng phần mềm để triển khai một tác vụ đơn cử. Hướng dẫn sử dụng thường được định dạng dưới dạng hướng dẫn in hoặc PDF, mặc dầu một số ít file trợ giúp gồm có các chủ đề về cách thực thi các tác vụ đơn cử. ( Các chủ đề trợ giúp này thường không nhạy cảm với ngữ cảnh, mặc dầu chúng hoàn toàn có thể được siêu link đến từ các chủ đề đó ) .

Xem thêm: Top 34 cách cài htkk mới nhất hay nhất 2022

Quyết định (các) dạng tài liệu sẽ có. Tài liệu phần mềm dành cho người dùng cuối có thể có 1 hoặc nhiều dạng: sách hướng dẫn in, tài liệu PDF, file trợ giúp hoặc trợ giúp trực tuyến. Mỗi biểu mẫu được thiết kế để chỉ cho người dùng cách sử dụng từng chức năng của chương trình, cho dù ở dạng hướng dẫn hay hướng dẫn; trong trường hợp file trợ giúp và trợ giúp trực tuyến, điều này có thể bao gồm video trình diễn cũng như văn bản và đồ họa tĩnh.

Các file trợ giúp và trợ giúp trực tuyến phải được lập chỉ mục và trọn vẹn hoàn toàn có thể tìm kiếm từ khóa để cho phép người dùng nhanh gọn tìm thấy thông tin họ đang tìm kiếm. Mặc dù những công cụ tạo file trợ giúp trọn vẹn hoàn toàn có thể tự động hóa tạo chỉ mục, nhưng thường tốt hơn là tạo chỉ mục theo cách thủ công bằng tay, sử dụng những thuật ngữ mà người dùng trọn vẹn hoàn toàn có thể tìm kiếm .

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

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

Có bất kỳ công cụ miễn phí nào cho tài liệu phần mềm không?Hãy thử Doxygen để tạo ra các trang hướng dẫn dạng Web. Ngoài ra bạn có thể sử dụng LaTeX để xuất ra file PDF.Tôi đã thấy các lần nhấn phím được ghi lại ở nhiều định dạng. Có một tiêu chuẩn thực tế cho các mặt hàng hay tất cả chúng đều khác nhau?Không có tiêu chuẩn chung; tuy nhiên, bạn nên đặt tiêu chuẩn cho các tài liệu của riêng mình. Để có một vài ý tưởng, hãy xem Hướng dẫn tạo kiểu của Microsoft (có sẵn trên Amazon) và Hướng dẫn kiểu của Apple (https://help.apple.com/applestyleguide). Chúng có các phong cách khác nhau, vì vậy nếu bạn viết tài liệu đa nền tảng, bạn có thể sử dụng một số yếu tố từ hướng dẫn này và một số yếu tố từ hướng dẫn khác.

Lời khuyên

Thí dụ : Bạn hoàn toàn có thể ghép, chế ảnh và tạo các hiệu ứng nhờ công cụ SnagIt – một công cụ đơn thuần, tinh gọn dành cho nhóm UI / UX designer nghiệp dư .

Xem thêm: Top 34 cách cài htkk mới nhất hay nhất 2022

Giai điệu đặc biệt quan trọng quan trọng, đặc biệt quan trọng là khi viết tài liệu phần mềm cho người dùng cuối. Địa chỉ người dùng bằng ngôi thứ hai là ” bạn ” thay vì ” người dùng ” của ngôi thứ ba .

Những công cụ cần cho hỗ trợ viết tài liệu

Giai điệu đặc biệt quan trọng quan trọng quan trọng, đặc biệt quan trọng quan trọng là khi viết tài liệu phần mềm cho người dùng cuối. Địa chỉ người dùng bằng ngôi thứ hai là ” bạn ” thay vì ” người dùng ” của ngôi thứ ba .Công cụ phong cách thiết kế phần mềm : MS Word, Google Doc … Tài liệu Template chuẩn, thường là tài liệu mẫu từ các dự án Bất Động Sản cũ của công ty. Công cụ tạo ảnh chụp màn hình hiển thị, thí dụ : SnagIt. Công cụ phong thái phong cách thiết kế phần mềm : MS Word, Google Doc … Tài liệu Template chuẩn, thường là tài liệu mẫu từ những dự án Bất Động Sản Bất Động Sản Nhà Đất cũ của công ty. Công cụ tạo ảnh chụp màn hình hiển thị hiển thị, thí dụ : SnagIt .

Source: https://bacxiunong.com
Category: Blog