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

-

Xác định lý do marketing cho tài liệu của bạn.

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

 Mặc cho dù lý do tác dụng của ứng dụng là sẽ giúp người dùng hiểu cách sử dụng ứng dụng, nhưng mà cũng có những vì sao khác, ví dụ điển hình như hỗ trợ tiếp thị trường mềm, nâng cấp hình hình ảnh công ty với đáng để ý nhất là giảm chi tiêu hỗ trợ kỹ thuật. Trong một số trong những trường hợp, tư liệu là quan trọng để vâng lệnh các biện pháp nhất định hoặc các yêu cầu pháp lý khác.

Tuy nhiên, trong rất nhiều trường hợp, tài liệu phần mềm không nên sửa chữa cho thi công giao diện kém. Nếu như một screen ứng dụng yêu cầu hàng loạt tài liệu để lý giải nó, xuất sắc hơn hết bạn nên biến hóa thiết kế screen thành một thứ gì đó trực quan liêu hơn.

Hiểu khán giả mà nhiều người đang viết tài liệu mang lại họ. Trong hầu như các trường hợp, người tiêu dùng phần mềm bao gồm ít loài kiến ​​thức về máy tính xách tay ngoài những tác vụ mà ứng dụng họ sử dụng chất nhận được họ thực hiện. Gồm một số phương pháp để xác định cách giải quyết và xử lý nhu cầu của họ bằng tài liệu của bạn.

Nhìn vào chức vụ công việc mà người dùng tiềm năng của khách hàng đang vậy giữ. Cai quản trị viên hệ thống có thể là chuyên gia về một trong những ứng dụng phần mềm, trong lúc 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. Chúng ta nên lên phát minh viết từ tổng thể đến đưa ra tiết, theo từng flows ứng cùng với từng vai trò người dùng. Thí dụ như sau:
*
Nhìn vào chính bạn dùng. Mặc mặc dù chức danh quá trình thường chỉ ra phần lớn gì mọi tín đồ làm, nhưng có thể có sự khác biệt đáng kể về kiểu cách sử dụng một vài chức danh khăng khăng trong một đội chức tuyệt nhất định. Bằng cách phỏng vấn những người tiêu dùng tiềm năng, bạn có thể biết được liệu tuyệt hảo của chúng ta về phần lớn gì chức danh các bước của họ chỉ ra có đúng đắn hay không.Xem tài liệu hiện nay có. Tài liệu cho các phiên phiên bản trước của phần mềm, cũng tương tự các thông số kỹ thuật kỹ thuật chức năng, cung cấp một số chỉ dẫn về mọi gì tín đồ dùng cần phải biết để sử dụng chương trình. Mặc dù nhiên, hãy ghi nhớ rằng người dùng cuối không quan tâm đến cách buổi giao lưu của chương trình mà lại chúng hoàn toàn có thể làm được gì cho họ.Xác định các nhiệm vụ nên thiết để triển khai công việc, và những trách nhiệm nào buộc phải phải tiến hành trước khi hoàn toàn có thể thực hiện được những nhiệm vụ đó.

*

Xác định (các) định dạng thích hợp cho tài liệu. Tài liệu phần mềm có thể được cấu tạo theo một trong những 2 định dạng, tài liệu tìm hiểu thêm và khuyên bảo sử dụng. Đôi khi, kết hợp các format là biện pháp 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 chức năng riêng lẻ của một ứng dụng phần mềm (nút, tab, trường cùng hộp thoại) và biện pháp chúng hoạt động. Các file trợ góp được viết ở định hình này, đặc biệt là trợ góp theo ngữ cảnh hiển thị chủ thể có liên quan bất cứ bao giờ người cần sử dụng nhấp vào nút trợ giúp trên một screen cụ thể.Định dạng lí giải sử dụng lý giải cách sử dụng phần mềm để tiến hành một tác vụ rứa thể. Hướng dẫn sử dụng thường được format dưới dạng giải đáp in hoặc PDF, tuy nhiên một số file trợ giúp bao hàm các chủ thể về cách thực hiện các tác vụ thay thể. (Các chủ thể trợ giúp này thường xuyên không nhạy cảm với ngữ cảnh, mặc dù chúng rất có thể được siêu liên kết đến từ những chủ đề đó).  

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

Xem thêm: Các Chứng Từ Mua Bán Ngoại Tệ Kỳ Hạn, Hạch Toán Ngoại Tệ

Các file trợ giúp với trợ góp trực tuyến yêu cầu được lập chỉ mục và có thể tìm kiếm từ khóa để được cho phép người dùng hối hả tìm thấy thông tin họ vẫn tìm kiếm. Tuy nhiên các vẻ ngoài tạo file trợ giúp có thể tự động hóa tạo chỉ mục, nhưng thường xuất sắc hơn là tạo chỉ mục theo phong cách thủ công, sử dụng các thuật ngữ mà bạn dùng có thể tìm kiếm.

Chọn điều khoản tài liệu ham mê 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 biên soạn thảo văn bạn dạng phức tạp như Frame
Maker, tùy trực thuộc vào độ dài với độ phức tạp của chúng. Tệp tin trợ giúp rất có thể được viết bằng công nuốm tạo giúp đỡ như Robo
Help, Help với Manual, Doc-To-Help, Flare, Help
Logix hoặc Help
Server.

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

Có bất kỳ công vậy miễn giá tiền nào cho tài liệu phần mềm không?Hãy demo Doxygen để tạo nên các trang lý giải dạng Web. Bên cạnh ra bạn cũng có thể sử dụng La
Te
X nhằm xuất ra file PDF.Tôi sẽ thấy những lần dìm phím được lưu lại ở các định dạng. Gồm một tiêu chuẩn thực tế mang lại các sản phẩm hay tất cả chúng rất nhiều khác nhau?Không có tiêu chuẩn chung; tuy nhiên, bạn nên được đặt tiêu chuẩn cho những tài liệu của riêng mình. Để tất cả một vài ý tưởng, hãy xem phía dẫn chế tạo ra kiểu của Microsoft (có sẵn trên Amazon) và lí giải kiểu của táo (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ố trong những yếu tố từ gợi ý này và một trong những yếu tố từ hướng dẫn khác.

Lời khuyên

Thí dụ: chúng ta cũng có thể ghép, chế hình ảnh và tạo các hiệu ứng nhờ luật Snag
It - một công cụ solo giản, tinh gọn giành riêng cho nhóm UI/UX designer nghiệp dư.

*

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

 

Những công cụ phải cho cung ứng viết tài liệu

Công cụ xây dựng phần mềm: MS Word, Google Doc...Tài liệu Template chuẩn, thường là tài liệu mẫu mã từ các dự án cũ của công ty.Công nuốm tạo hình ảnh chụp màn hình, thí dụ: Snag
It.
Sứ mệnh:"Cung cấp các sản phẩm đào chế tạo ra và nghiên cứu khoa học tài bao gồm - kế toán rất chất lượng cho làng hội"
trình làng tin tức Đào tạo và Bồi dưỡng Sau ĐH tuyển sinh Tra cứu tin tức nhập học tập QLVB nghiên cứu KH hội thảo chiến lược KH Hội đồng CDGSCS
Đăng Nhập
*
English
Nhằm hướng đến sự chuẩn hóa vào việc trình diễn Danh mục Tài liệu tìm hiểu thêm theo chuẩn chỉnh quốc tế. Ban HTQT liên tục gửi đến bài xích 2.

Hướng dẫn sử dụng ứng dụng trình bày hạng mục Tài liệu tìm hiểu thêm theo biện pháp quốc tế tiếp theo sau Bài 1. Phía dẫn chất vấn Tạp chí quốc tế: https://kiemtailieu.com/tabid/102/id/33549/Default.aspx).

Phần 1. Rất nhiều quy định thế giới về trình bày tài liệu tham khảo

Hiểu về mã JEL (Journal of Economic Literature) https://www.aeaweb.org/econlit/jel
Codes.php?view=jel

Đây là mã phân loại Tạp chí khiếp tế, thuộc JEL gồm các tập lớn được ký hiệu theo bảng chữ cái Alphabet, trong các tập lớn được tiếp tục chi tiết theo các tập nhỏ hơn

A (General Economics & Teaching: ghê tế phổ biến và giáo dục), chứa đựng các ký hiệu đưa ra tiết hơn đến cấp tía chữ số

Ví dụ 1: A1 General Economics (A1; A10; A100); A2 Economic Education and Teaching of Economics; A3 Collective Works. Tương tự:

B History of Economic Thought, Methodology, and Heterodox Approaches

C Mathematical & Quantitative Methods

D Microeconomics

E Macroeconomics & Monetary Economics

F International Economics

G Financial Economics

H Public Economics

I Health, Education, and Welfare

J Labor and Demographic Economics

K Law & Economics

L Industrial Organization

M Business Administration & Business Economics; Marketing; Accounting; Personnel Economics

N Economic History

O Economic Development, Innovation, Technological Change, và Growth

P Economic Systems

Q Agricultural & Natural Resource Economics; Environmental and Ecological Economics

R Urban, Rural, Regional, Real Estate, & Transportation Economics

Y Miscellaneous Categories

Z Other Special Topics

Mã này luôn được lộ diện ở các công bố quốc tế để khẳng định các nghành nghiên cứu

Hiểu về cách trình bày danh mục tài liệu tham khảo

Minh họa về sử dụng 02 cách trình bày danh mục tài liệu tham khảo đang thông dụng là APA (American Psychological Association

https://www.mendeley.com/guides/APA-citation-guide)

và Harvard (Harvard Reference Style Guide:

https://www.mendeley.com/guides/harvard-citation-guide)

Ngoài ra, còn rất nhiều cách quy định về trình diễn Danh mục tài liệu tham khảo, nhờ vào vào vị trí công bố. Những mức sử dụng này phía dẫn cụ thể cách trình bày khi trích dẫn so với từng ngôi trường hợp vắt thể

Phần 2. Sử dụng phần mềm Mendelay để trình bày tài liệu tham khảo

Bước 1. Download và cài đặt phần mềm Mendey (sau khi tạo account ngừng có thể dùng cả online với offline). Https://www.mendeley.com/download-desktop-new/

*

Bước 2. Tạo những thư mục (Folder) về các lĩnh vực, ví dụ nghành Kế toán tài chính; nghành nghề Kế toán quản trị; nghành kiểm toán…Cách làm:

(1) bấm chuột New folder và đặt lại tên folder

(2) add các tệp tin (bài báo…) vào folder theo 02 từ thời điểm cách đó là (1) mở phần đa file sẽ lưu trữ, bấm giữ và thả vào folder; (2) bấm nút showroom (+) sinh sống thanh công cụ/đường dẫn/chọn file (có thể lựa chọn 1 hoặc các file)

(3) nhấn vào file vừa địa chỉ để kiểm soát lại các thông tin, như tên Journal. ISSN, Page, Volume, Author, DOI…

*

(4) click chuột Sync: để đồng hóa dữ liệu

Bước 3. Thực hành trích dẫn vào word

+ link giữa Mendeley cùng Word: mở word với trang/file/Option/Add-ins/Mendeley với tại Manager chọn đổi sang trọng Template (thông thường trước khi đổi đang là COM Add-ins

+ trên trang Word:

(1) Bấm References để soát sổ xem tất cả sự liên kết với Mandeley chưa;

(2) chọn Style: dạng trích dẫn, hiểu kỹ quy định của tập san về trích dẫn mà chắt lọc style phù hợp

(3) Bấm Insert Citation để thừa nhận trích dẫn theo 02 cách: (1) Tự ghi nhớ tên bài bác báo hoặc tên tác giả hoặc (2) hoặc bấm go to lớn Mandeley/chọn file bài bác báo/ và nhấn (có thể lựa chọn các bài)

Ví dụ 2: (Tu et al., 2019)

Bước 4. Tại Word phần hạng mục tài liệu tham khảo: Insert Bibliography thì tư liệu trích dẫn sẽ auto hiện ra

Tu, C. A. et al. (2019) ‘Strengthening the Application of Management Accounting khổng lồ Improve Operational Efficiency At Vietnamese’, 23(3), pp. 1–15.

Ngoài ra, cũng có thể lựa chọn phần mềm Endnote có tác dụng tương tự để gia công Danh mục tài liệu tham khảo