Trang này đang hoàn thiện!
Báo cáo nền tảng kỹ thuật khó để xác định—nó là không nhiều điều, nhưng rất khó để nói rõ điều gì là. Nó không cung cấp hướng dẫn từng bước về cách làm một cái gì đó giống như cách mà các hướng dẫn thường làm. Nó không đưa ra các khuyến nghị một cách chính thức như các báo cáo khả thi. Nó không báo cáo dữ liệu từ nghiên cứu nguyên gốc và rút ra kết luận như các báo cáo nghiên cứu chính.
Vậy thì báo cáo nền tảng kỹ thuật làm gì? Nó cung cấp thông tin về một chủ đề kỹ thuật nhưng theo cách phù hợp với một đối tượng cụ thể có nhu cầu cụ thể về thông tin đó. Hãy tưởng tượng một chủ đề như thế này: bệnh thận và liệu pháp. Một báo cáo nền tảng kỹ thuật về chủ đề này sẽ không đổ ra một cuốn sách giáo khoa nặng mười tấn chứa tất cả mọi thứ bạn có thể nói về nó. Nó sẽ chọn thông tin về chủ đề phù hợp với một nhóm độc giả cụ thể có nhu cầu và cách sử dụng thông tin nhất định. Hãy tưởng tượng khán giả là một nhóm kỹ sư đang đấu thầu một hợp đồng để thực hiện một phần công việc cho một phòng khám lọc máu. Vâng, họ cần biết về bệnh thận và liệu pháp của nó, nhưng chỉ trong phạm vi có liên quan đến lĩnh vực chuyên môn của họ. Một báo cáo nền tảng như vậy cũng có thể bao gồm một số thảo luận cơ bản về bệnh thận và cách điều trị của nó, nhưng không nhiều hơn những gì các kỹ sư cần để thực hiện công việc của họ và tương tác với các đại diện của phòng khám.
Hãy xem các ví dụ về báo cáo nền tảng kỹ thuật.
Một trong những báo cáo là sự khám phá về hiện tượng ấm lên toàn cầu, hay hiệu ứng nhà kính, như được gọi trong báo cáo. Lưu ý rằng nó thảo luận về các nguyên nhân, sau đó khám phá các tác động, và sau đó bàn về những gì có thể làm để giải quyết vấn đề này.
Nội dung và Cấu trúc của Báo cáo Nền tảng Kỹ thuật
Khác với hầu hết các báo cáo khác được thảo luận trong hướng dẫn khóa học này, báo cáo nền tảng kỹ thuật không có một tập hợp nội dung chung. Bởi vì nó tập trung vào một chủ đề kỹ thuật cụ thể cho những khán giả cụ thể có nhu cầu hoặc mục đích cụ thể với thông tin, nó sẽ chọn bất kỳ loại nội dung nào cần thiết để hoàn thành công việc. Bạn sẽ phải sử dụng nhiều trực giác để lập kế hoạch cho loại báo cáo này. Ví dụ, với báo cáo về bệnh thận và điều trị, bạn có thể muốn thảo luận về bệnh thận là gì, nguyên nhân gây ra nó, cách điều trị như thế nào và những công nghệ nào liên quan đến việc điều trị. Nếu bạn không hoàn toàn tin tưởng vào trực giác của mình, hãy sử dụng một danh sách kiểm tra như sau:
- Định nghĩaĐịnh nghĩa các thuật ngữ có thể không quen thuộc liên quan đến chủ đề. Viết mở rộng định nghĩa nếu có các thuật ngữ chính hoặc nếu chúng khó giải thích.
- Nguyên nhânGiải thích những nguyên nhân liên quan đến chủ đề. Ví dụ, với chủ đề bệnh thận, nguyên nhân gây ra bệnh là gì?
- Tác độngGiải thích các hậu quả, kết quả, hoặc ảnh hưởng liên quan đến chủ đề. Với chủ đề bệnh thận, những gì xảy ra với những người mắc bệnh; các phương pháp điều trị khác nhau có ảnh hưởng gì?
- Các loại—Thảo luận về các loại hoặc danh mục khác nhau liên quan đến chủ đề. Ví dụ, có những loại bệnh thận khác nhau không; có các danh mục điều trị khác nhau không?
- Bối cảnh lịch sử—Thảo luận về lịch sử liên quan đến chủ đề. Thảo luận về con người, sự kiện và các lý thuyết trong quá khứ liên quan đến chủ đề.
- Quy trình—Thảo luận về các quá trình cơ khí, tự nhiên, và do con người kiểm soát liên quan đến chủ đề này. Giải thích từng bước cách mà quá trình diễn ra. Ví dụ, các giai đoạn của chu kỳ bệnh thận là gì; điều gì thường xảy ra với một người có một hình thức cụ thể của bệnh?
- Mô tả—Cung cấp thông tin về các chi tiết vật lý của những thứ liên quan đến chủ đề. Cung cấp thông tin về kích thước, hình dạng, màu sắc, trọng lượng, và những yếu tố khác. Đối với tài liệu kỹ thuật hướng đến kỹ thuật, điều này sẽ có nghĩa là kích thước, yêu cầu về công suất, và các chi tiết khác về các công nghệ xử lý.
- So sánh—So sánh chủ đề, hoặc một số khía cạnh của nó, với một cái gì đó tương tự hoặc quen thuộc. Với ví dụ về bệnh thận, bạn có thể so sánh bệnh thận với một bệnh khác; phương pháp điều trị với một phương pháp điều trị khác; các chức năng của thận với một cái gì đó quen thuộc (một phép ẩn dụ); hoặc thậm chí phương pháp điều trị với một cái gì đó quen thuộc, ví dụ, hệ thống lọc nước cho bể bơi.
- Ứng dụng—Khám phá cách một khía cạnh nào đó của chủ đề của bạn có thể được sử dụng hoặc áp dụng. Nếu đó là một công nghệ mới, các ứng dụng của nó là gì?
- Ưu điểm và nhược điểm—Thảo luận về những lợi ích hoặc bất lợi của một hoặc nhiều khía cạnh của chủ đề của bạn. Trong chủ đề bệnh thận, chẳng hạn, lợi ích của một phương pháp điều trị so với phương pháp khác là gì?
- Các yếu tố kinh tế—Thảo luận về chi phí của một hoặc nhiều khía cạnh liên quan đến chủ đề của bạn. Chi phí điều trị bệnh thận là bao nhiêu? Chi phí cho thiết bị và nhân sự là bao nhiêu?
- Ý nghĩa xã hội, chính trị, pháp lý, đạo đức—Khám phá các hệ quả hoặc tác động của chủ đề của bạn hoặc một khía cạnh nào đó liên quan đến các vấn đề xã hội, chính trị, pháp lý hoặc đạo đức. Ví dụ về bệnh thận không thuận lợi cho lĩnh vực này lắm, nhưng hãy tưởng tượng những khả năng với một chủ đề như cryogenics—tình trạng ngừng hoạt động của con người. Thường thì, các công nghệ mới có tác động sâu sắc trong những lĩnh vực này.
- Vấn đề, câu hỏi—Có những vấn đề hoặc câu hỏi nào liên quan đến chủ đề techdoc của bạn hoặc một khía cạnh nào đó của nó?
- Giải pháp, câu trả lời—Bạn có thể cung cấp giải pháp hoặc câu trả lời nào cho những vấn đề hoặc câu hỏi được nêu ra bởi chủ đề của bạn hoặc một khía cạnh nào đó của nó?
Chúng ta có thể thêm nhiều danh mục khác vào danh sách kiểm tra như thế này, nhưng có lẽ đây là đủ để giúp bạn bắt đầu lập kế hoạch cho nội dung của báo cáo kỹ thuật của bạn. Và hãy nhớ rằng mỗi mục trong danh sách kiểm tra này có thể đại diện cho một phần đầy đủ trong báo cáo—chứ không chỉ là một hoặc hai câu.
Về việc tổ chức các phần của báo cáo này, một lần nữa, trực giác của bạn là đúng. Một số tiểu đề logic xuất hiện trước những tiểu đề khác. Xem chương về các mô hình tổ chức và áp dụng chúng.
Định dạng của Báo cáo Nền tảng Kỹ thuật
Chương đó dẫn bạn từ bìa trước cho đến trang cuối cùng trong loại báo cáo này, cho thấy nội dung và định dạng dự kiến. Hãy nhớ rằng trong hầu hết các khóa học viết kỹ thuật, bạn được mong đợi sử dụng định dạng như thế này một cách chính xác—trừ khi bạn thỏa thuận những gì khác với giảng viên của mình.
Thông tin liên quan
Bài kiểm tra đọc hiểu. Sử dụng bài kiểm tra này để kiểm tra sự hiểu biết của bạn về chương này.
Đào tạo có sẵn. Hãy luyện tập viết với McMurrey như là giảng viên của bạn.
Tôi rất trân trọng ý kiến, phản ứng và sự phê bình của bạn về chương này: phản hồi của bạn—David McMurrey.
