Làm thế nào để phác thảo tài liệu viết kỹ thuật

Anonim

Làm thế nào để phác thảo tài liệu viết kỹ thuật. Một tài liệu được viết tốt không được tạo ra một cách tình cờ. Các tài liệu trong một báo cáo, hướng dẫn hoặc tài liệu kỹ thuật khác được lên kế hoạch, tổ chức và sau đó được viết. Giai đoạn phác thảo của tài liệu là một bước quan trọng và rất có thể thông tin sẽ không được trình bày một cách hợp lý nếu một phác thảo không được tạo. Phác thảo cung cấp cho tác giả một cơ hội để suy nghĩ về thông tin nên và không nên được đưa vào.

Động não ý tưởng của bạn. Viết ra bất kỳ ý tưởng nào trong đề cương của bạn mà bạn nghĩ nên được đưa vào tài liệu kỹ thuật. Đừng quan tâm đến thứ tự của thông tin. Nó chỉ là vấn đề mà tất cả các thông tin được bao gồm trong quá trình động não.

Xác định mục đích của tài liệu kỹ thuật. Hãy tự hỏi mình những câu hỏi như ai sẽ đọc tài liệu, tại sao nó sẽ được đọc và nó sẽ được sử dụng như thế nào.

Quyết định loại phác thảo bạn muốn tạo: lịch sử, theo trình tự thời gian, cụ thể cho chung, từ nhỏ đến lớn, đơn giản đến phức tạp hoặc bất kỳ hình thức nào khác phù hợp với nội dung. Hãy suy nghĩ về khán giả và về thông tin mà bạn muốn trình bày. Hãy chắc chắn rằng cách sắp xếp thông tin có ý nghĩa nhất đối với loại thông tin được trình bày và đối tượng sẽ đọc tài liệu kỹ thuật.

Sắp xếp thông tin theo thứ tự phù hợp. Một phác thảo liên quan đến việc nhóm các thông tin thành các phần và cấp độ logic. Bạn có thể tạo chủ đề chính và chủ đề phụ và chủ đề phụ.

Kết thúc đề cương bằng cách xem xét thông tin để xác minh rằng các đối tượng được tổ chức phù hợp và hợp lý. Hãy chắc chắn rằng bạn không thiếu bất kỳ sự kiện quan trọng nào. Xóa mọi thông tin không liên quan đến tài liệu kỹ thuật.