Technical Documentation Copy and Paste Kit

Sự miêu tả

Không, bộ tài liệu này sẽ không viết hướng dẫn sử dụng tiếp theo hoặc hệ thống trợ giúp trực tuyến tiếp theo cho bạn. Tuy nhiên, bộ công cụ này sẽ giúp bạn viết tài liệu kỹ thuật của mình với ít nỗ lực hơn và nó sẽ giúp bạn tạo ra các tài liệu chất lượng cao, thân thiện với người dùng.

Bộ công cụ này cung cấp cho bạn chính xác những thứ mà trình soạn thảo văn bản, công cụ hỗ trợ soạn thảo hoặc hệ thống quản lý nội dung của bạn không cung cấp: bí quyết và hướng dẫn để tạo hỗ trợ người dùng chất lượng cao.

Tuy nhiên, không giống như nhiều sách giáo khoa về kỹ thuật viết, bộ tài liệu này không cung cấp những giải thích lý thuyết dài dòng. Nó đưa ra các khuyến nghị và ví dụ thực tế mà bạn có thể dễ dàng ghi nhớ và thích ứng với công việc của mình.

Bộ bao gồm:

* thiết kế trực quan (bố cục) tài liệu của bạn

* cấu trúc tài liệu của bạn

* cách viết hướng dẫn đơn giản mà mọi người dùng đều hiểu

Bạn không cần phải là một nhà thiết kế để thực hiện các đề xuất thiết kế và bạn không cần phải là một nhà ngôn ngữ học để hiểu các quy tắc viết. Tất cả các khuyến nghị đi kèm với các ví dụ hấp dẫn.

Bộ tài liệu này được viết bằng tiếng Anh thuần túy, đơn giản mà bạn có thể dễ dàng hiểu ngay cả khi bạn nói tiếng Anh như ngôn ngữ thứ hai. Hầu hết tất cả các quy tắc đều phổ biến, vì vậy bạn cũng có thể sử dụng bộ tài liệu này nếu bạn viết bằng ngôn ngữ khác ngoài tiếng Anh.

Trong Phiên bản Plus của bộ công cụ, bạn và nhóm của bạn có thể thêm các quy ước và quy định dành riêng cho công ty của bạn. Nhận hướng dẫn về phong cách viết tương tác chuyên nghiệp nhưng tùy chỉnh chưa bao giờ dễ dàng hơn thế. Bạn có thể tự do kiểm soát ai có thể chỉnh sửa các quy tắc: chỉ bạn, chỉ các thành viên trong nhóm được chọn hoặc tất cả mọi người.