Làm thế nào để viết một thông số kỹ thuật (có hình ảnh)

Mục lục:

Làm thế nào để viết một thông số kỹ thuật (có hình ảnh)
Làm thế nào để viết một thông số kỹ thuật (có hình ảnh)

Video: Làm thế nào để viết một thông số kỹ thuật (có hình ảnh)

Video: Làm thế nào để viết một thông số kỹ thuật (có hình ảnh)
Video: Làm chủ câu bị động (Passive Voice) trong 5 phút [Ngữ pháp tiếng Anh cơ bản - Các loại câu #6] 2024, Tháng Ba
Anonim

Đặc tả kỹ thuật (tech spec) là tài liệu giải thích sản phẩm hoặc dự án sẽ hoạt động như thế nào và bạn sẽ đạt được những mục tiêu này như thế nào. Trong thông số kỹ thuật, hãy cho khách hàng và các thành viên nhóm của bạn biết vấn đề bạn đang giải quyết, mục tiêu hoặc yêu cầu đối với dự án hoặc sản phẩm của bạn và cách bạn lên kế hoạch để đạt được điều này. Thông số kỹ thuật hướng dẫn công việc được hoàn thành và bạn thường sẽ viết lại nó khi dự án của bạn tiến triển.

Các bước

Phần 1/3: Viết tiêu đề của bạn

Viết thông số kỹ thuật Bước 1
Viết thông số kỹ thuật Bước 1

Bước 1. Đặt tên dự án ở trên cùng bằng cách sử dụng phông chữ sans serif 14 pt hoặc 16 pt

Đây là tên sản phẩm của bạn hoặc tên công việc của chính dự án. Sử dụng phông chữ sans serif ở 14-pt hoặc 16-pt để dễ đọc. Căn trái hoặc căn giữa, tùy thuộc vào sở thích của bạn.

Nơi làm việc hoặc người hướng dẫn của bạn có thể cung cấp cho bạn một mẫu hướng dẫn bạn cách viết tiêu đề. Luôn làm theo mẫu nếu có

Bạn có biết không?

Phông chữ sans serif không có các nét cuối trên các chữ cái, vì vậy các kiểu chữ này có cái nhìn hiện đại hơn. Các phông chữ sans serif phổ biến nhất là Arial, Calibri và Verdana.

Viết thông số kỹ thuật Bước 2
Viết thông số kỹ thuật Bước 2

Bước 2. Viết ngày tháng bên dưới tên dự án bằng phông chữ sans serif 12 pt

Chuyển đến dòng tiếp theo và giảm kích thước phông chữ của bạn xuống 12-pt. Sử dụng cùng một phông chữ sans serif mà bạn đã sử dụng để viết tên dự án của mình. Sau đó, nhập ngày bằng tháng, ngày và năm.

  • Nếu mẫu của bạn khác, hãy định dạng ngày của bạn theo mẫu.
  • Điều quan trọng là phải bao gồm ngày tháng để bạn có thể biết thông số kỹ thuật nào là thông số kỹ thuật gần đây nhất.
Viết thông số kỹ thuật Bước 3
Viết thông số kỹ thuật Bước 3

Bước 3. Nhập “Tác giả” và tên của tác giả dưới ngày tháng

Chuyển đến dòng tiếp theo và viết “Tác giả”, theo sau là dấu hai chấm. Sau đó, đặt tên của bạn vì bạn là người viết thông số kỹ thuật. Luôn chỉ đặt tên của bạn, ngay cả khi bạn đã thảo luận về nội dung của thông số kỹ thuật với một nhóm.

Thông số kỹ thuật luôn cần có một tác giả, ngay cả khi bạn đang làm việc với một nhóm. Tác giả là người thực sự đánh máy thông số kỹ thuật

Viết thông số kỹ thuật Bước 4
Viết thông số kỹ thuật Bước 4

Bước 4. Đặt “Đội” và cuối cùng tên của các thành viên trong nhóm

Trên dòng tiếp theo, nhập “Nhóm”, theo sau là dấu hai chấm. Sau đó, viết ra tên của từng thành viên trong nhóm đang làm việc trong dự án hoặc sản phẩm.

  • Ngoài việc cấp tín dụng cho các thành viên trong nhóm của bạn, điều này giúp mọi người hiểu họ có thể gặp ai nếu họ có thắc mắc về thông số kỹ thuật.
  • Nếu bạn đã làm việc một mình trong dự án này, hãy bỏ qua bước này.

Phần 2/3: Soạn thảo Thông số kỹ thuật

Viết thông số kỹ thuật Bước 5
Viết thông số kỹ thuật Bước 5

Bước 1. Cung cấp một bản tóm tắt tổng quan hoặc ngắn gọn về dự án hoặc sản phẩm

Bắt đầu thông số kỹ thuật của bạn với một bản tóm tắt về những gì bạn đang làm. Nhập "Tổng quan" hoặc "Tóm tắt ngắn gọn" làm tiêu đề của bạn. Giải thích vấn đề, sau đó tóm tắt dự án hoặc sản phẩm là gì và nó sẽ làm gì. Tiếp theo, giải thích cách tiếp cận của bạn để hoàn thành nó sẽ là gì và bao gồm thông số kỹ thuật của sản phẩm nếu đó là thiết bị. Liên kết đến bất kỳ tài liệu tiếp thị hoặc kỹ thuật nào quan trọng đối với dự án. Cuối cùng, cung cấp ước tính thời gian sơ bộ về thời gian sẽ hoàn thành dự án hoặc sản phẩm.

Bạn có thể viết, “Hệ thống hiện tại để lập kế hoạch các chuyến đi chuyển tuyến qua quận khiến người đi xe bị mắc kẹt và giảm lượng người đi trên các tuyến đường nhất định. Hai trong số các hệ thống xe buýt cho phép hành khách lập kế hoạch chuyến đi của họ trực tuyến, nhưng hệ thống thứ ba sử dụng bản đồ giấy và liên lạc qua điện thoại. Giải pháp này đang làm giảm số lượng hành khách và gây ra tình trạng thiếu kinh phí, hãy xem kết quả khảo sát Mùa xuân 2019. Chúng tôi muốn chuyển cả 3 tuyến chuyển tuyến vào 1 hệ thống quy hoạch mà người dùng có thể truy cập trực tuyến. Điều này sẽ cho phép họ lập kế hoạch các chuyến đi của mình dễ dàng hơn và biết khi nào xe buýt sẽ đến tại mỗi điểm dừng. Ngoài ra, người lái có thể báo cáo sự cố ngay lập tức bằng chức năng 'liên hệ với chúng tôi'."

Viết thông số kỹ thuật Bước 6
Viết thông số kỹ thuật Bước 6

Bước 2. Bao gồm phần mục tiêu nếu chúng không có trong phần tổng quan hoặc tóm tắt ngắn gọn

Nhập "Mục tiêu" làm tiêu đề, sau đó phác thảo ngắn gọn những gì bạn dự định đạt được với dự án hoặc sản phẩm của mình. Viết một tuyên bố dẫn đầu, sau đó liệt kê các mục tiêu của bạn trong một danh sách được đánh số hoặc đánh dấu đầu dòng.

  • Nếu bạn phác thảo mục tiêu của mình trong phần tổng quan, bạn thường không cần phần này. Tuy nhiên, bạn có thể được yêu cầu bao gồm phần này nếu nơi làm việc của bạn yêu cầu.
  • Viết một cái gì đó như, “Hệ thống mới sẽ bao gồm: 1) Một công cụ lập kế hoạch tuyến đường; 2) Chức năng định vị xe buýt; 3) Một cách để các tay đua thông báo sự cố.”
Viết thông số kỹ thuật Bước 7
Viết thông số kỹ thuật Bước 7

Bước 3. Viết các yêu cầu về sản phẩm trong một phần riêng biệt

Tiếp theo, nhập "Yêu cầu sản phẩm" làm tiêu đề, sau đó là những việc sản phẩm của bạn cần làm để giải quyết vấn đề của bạn. Sử dụng một danh sách gạch đầu dòng và đừng lo lắng về một câu dẫn đầu.

Ví dụ: “1) Công cụ lập kế hoạch lộ trình đảm bảo người đi xe không bị mắc kẹt và xe buýt không hoạt động kém hiệu quả; 2) Hộp liên lạc cho phép các nhà lập kế hoạch chuyển tuyến trực tiếp trả lời các vấn đề của người lái.”

Viết thông số kỹ thuật Bước 8
Viết thông số kỹ thuật Bước 8

Bước 4. Giải thích những điều nằm ngoài phạm vi dự án của bạn

Đặt tiêu đề cho phần này là “Ngoài phạm vi” hoặc “Không phải mục tiêu”. Đừng viết lời dẫn hoặc đoạn văn. Thay vào đó, hãy tạo một danh sách gạch đầu dòng về những việc bạn sẽ không làm để giải quyết vấn đề của mình. Điều này bao gồm công việc bạn sẽ không làm, các giải pháp bạn không nghĩ sẽ hiệu quả và các thuộc tính sản phẩm hoặc dự án của bạn sẽ không có. Hãy kỹ lưỡng để khách hàng và nhóm của bạn không có bất kỳ hiểu lầm nào.

Bạn có thể viết, “1) Hệ thống này sẽ không thêm các tuyến xe buýt mới; 2) Chúng tôi sẽ không cài đặt máy tính tại các điểm dừng xe buýt hoặc trên xe buýt, vì vậy người đi xe sẽ cần sử dụng thiết bị riêng của họ; 3) Các nhà lập kế hoạch vận tải sẽ không đảm bảo các giải pháp tức thì cho các vấn đề của người lái; và 4) Dịch vụ này sẽ không bao gồm dịch vụ đón tận nơi.”

Biến thể:

Đôi khi phần này được đặt gần cuối thông số kỹ thuật trước dòng thời gian. Sử dụng vị trí ưa thích của bạn hoặc làm những gì phổ biến nhất ở nơi làm việc của bạn.

Viết thông số kỹ thuật Bước 9
Viết thông số kỹ thuật Bước 9

Bước 5. Bao gồm phần “Câu hỏi mở” nếu bạn có vấn đề chưa được giải quyết

Thông số kỹ thuật của bạn là một bản phác thảo nhanh về sản phẩm hoặc dự án để khách hàng của bạn hiểu những gì họ đang nhận được và nhóm của bạn đang làm việc theo cùng một mục tiêu. Đừng lo lắng về việc bao gồm mọi chi tiết hoặc trả lời các câu hỏi "cần được xác định" của bạn. Thay vào đó, hãy nhập tiêu đề “Câu hỏi mở” và trình bày danh sách dấu đầu dòng về những điều bạn sẽ quyết định sau này.

Viết, “1) Chúng tôi sẽ quản lý các bản cập nhật hệ thống như thế nào? 2) Chúng tôi sẽ thay đổi bản đồ tuyến đường nếu chúng tôi phát hiện ra vấn đề? 3) Hệ thống có thể phục vụ hành khách đa ngôn ngữ mà không có lỗi dịch không? 4) Làm thế nào chúng tôi sẽ phục vụ tốt nhất những người lái xe không hiểu biết về công nghệ?"

Viết thông số kỹ thuật Bước 10
Viết thông số kỹ thuật Bước 10

Bước 6. Trình bày kế hoạch của bạn trong phần "Tiếp cận"

Đặt tiêu đề cho phần này là “Kế hoạch” hoặc “Phương pháp tiếp cận”. Mô tả cách bạn sẽ giải quyết vấn đề hoặc các phương pháp tiếp cận khác nhau mà bạn đang xem xét nếu chưa đưa ra quyết định cuối cùng. Giải thích nghiên cứu của bạn và từng công nghệ hoặc quy trình mà bạn sẽ sử dụng. Nếu có thể, hãy bao gồm hình ảnh minh họa, biểu đồ và sơ đồ để người đọc hiểu kế hoạch của bạn dễ dàng hơn. Cuối cùng, thảo luận về cách bạn sẽ kiểm tra kế hoạch của mình và bạn sẽ làm gì nếu có vấn đề.

  • Nếu bạn mô tả các phương pháp tiếp cận hoặc công nghệ khác nhau, hãy tạo một tiểu mục cho từng phương pháp để dễ dàng thực hiện theo kế hoạch của bạn.
  • Viết đại loại như, “Chúng tôi sẽ làm việc với nhóm lập kế hoạch chuyển tuyến để thiết kế phần mềm cho phép người lái nhập điểm đến của họ vào một ứng dụng sẽ tạo tuyến đường cho họ. Người lái có thể thay đổi lộ trình nếu họ muốn. Hệ thống sẽ gửi thông tin cập nhật bằng văn bản cho người đi để giúp họ tìm ra tuyến đường của mình. Chúng tôi sẽ yêu cầu các tay đua trong một ủy ban các bên liên quan kiểm tra phần mềm trước khi chúng tôi phát hành nó ra công chúng. Nếu kế hoạch có lỗi, chúng tôi sẽ cập nhật trang web trong giờ khi xe buýt ngoại tuyến. Ngoài ra, chúng tôi sẽ có thêm một xe đưa đón để đón những hành khách bị mắc kẹt do hệ thống.”

Biến thể:

Bạn có thể bao gồm phần “Các thành phần” ở trên cùng để tóm tắt những gì kế hoạch hoặc cách tiếp cận của bạn sẽ đòi hỏi. Tuy nhiên, điều này thường là tùy chọn, trừ khi công ty hoặc người hướng dẫn của bạn yêu cầu.

Viết thông số kỹ thuật Bước 11
Viết thông số kỹ thuật Bước 11

Bước 7. Bao gồm các tùy chọn khác mà bạn đã cân nhắc nhưng đã loại trừ

Đặt phần này như một bước chính trong kế hoạch hoặc phương pháp tiếp cận của bạn hoặc đặt nó ở cuối thông số kỹ thuật trước dòng thời gian của bạn. Nhập tiêu đề “Các lựa chọn khác được xem xét”, sau đó mô tả các lựa chọn thay thế bạn đã cân nhắc trước khi chọn gói hiện tại của mình. Giải thích lý do tại sao bạn loại trừ từng tùy chọn.

Bạn có thể viết, “Chúng tôi đã xem xét bản đồ mã màu vì đây là một lựa chọn rẻ hơn, nhưng những người lái xe không phản ứng tốt với các bản đồ hiện có và nhóm thử nghiệm đã bối rối.”

Viết thông số kỹ thuật Bước 12
Viết thông số kỹ thuật Bước 12

Bước 8. Mô tả các phương pháp và thước đo của bạn để đánh giá sản phẩm hoặc dự án

Bao gồm thông tin này trong một phần hoặc nhiều phần. Đặt tiêu đề như “Đo lường tác động” hoặc “Giám sát” và “Chỉ số”. Trong một hoặc nhiều đoạn văn, hãy giải thích cách bạn đảm bảo sản phẩm hoặc dự án của mình đang hoạt động chính xác và hoàn thành mục tiêu. Ngoài ra, hãy mô tả cách bạn sẽ kiểm tra lỗi hoặc sự cố.

  • Bao gồm các quy trình hoặc công nghệ phân tích cụ thể mà bạn sẽ sử dụng.
  • Nói điều gì đó như, “Chúng tôi sẽ so sánh thời gian tuyến đường dự kiến với thời gian tuyến đường thực tế để đảm bảo xe buýt chạy đúng lịch trình. Ngoài ra, chúng tôi sẽ tiến hành khảo sát người lái để đánh giá mức độ hài lòng của họ và xác định các vấn đề với hệ thống.”
Viết thông số kỹ thuật Bước 13
Viết thông số kỹ thuật Bước 13

Bước 9. Xác định cách bạn sẽ cung cấp bảo mật và quyền riêng tư

Nhập tiêu đề “Bảo mật và quyền riêng tư”, sau đó giải thích cách bạn sẽ bảo vệ người dùng khỏi các cuộc tấn công mạng. Mô tả ngắn gọn các rủi ro và cách bạn sẽ bảo mật hệ thống của mình để quyền riêng tư được bảo vệ. Viết một vài đoạn văn để giải thích các phương pháp của bạn.

  • Luôn có rủi ro hoặc mối quan tâm, vì vậy đừng đặt "không có rủi ro" trong phần này.
  • Bạn có thể viết, “Người dùng sẽ nhập vị trí và địa chỉ nhà của họ. Ngoài ra, họ sẽ có tùy chọn tạo hồ sơ và lưu các chuyến đi. Để bảo vệ dữ liệu này, chúng tôi sẽ bao gồm mã hóa và tường lửa”.
Viết thông số kỹ thuật Bước 14
Viết thông số kỹ thuật Bước 14

Bước 10. Kết thúc với một dòng thời gian và danh sách các cột mốc quan trọng

Dòng thời gian giúp dự án của bạn đi đúng hướng và cho cả khách hàng và nhóm của bạn biết những gì cần phải làm. Đặt tiêu đề cho phần này là “Dòng thời gian”, sau đó phân tích các nhiệm vụ theo người đang thực hiện chúng. Bao gồm một danh sách dấu đầu dòng cho mỗi nhóm hoặc thành viên trong nhóm, tùy thuộc vào sở thích của bạn.

  • Ví dụ: bảng phân tích nhiệm vụ của bạn có thể liệt kê “Nhóm kỹ thuật”, “Nhóm lập kế hoạch”, “Tiếp thị” và “Đảm bảo chất lượng”.
  • Danh sách gạch đầu dòng của bạn cho nhóm kỹ thuật có thể bao gồm các nhiệm vụ như, “1) Viết nâng cấp trang web; 2) Viết ứng dụng lập kế hoạch chuyến đi; 3) Viết hệ thống liên lạc.”

Phần 3/3: Hoàn thiện thông số kỹ thuật của bạn

Viết thông số kỹ thuật Bước 15
Viết thông số kỹ thuật Bước 15

Bước 1. Một khoảng trắng cho tài liệu của bạn và bỏ qua 1 dòng giữa các phần

Sử dụng khoảng cách duy nhất để thông số kỹ thuật của bạn ngắn hơn và dễ xử lý hơn. Khi bạn muốn thay đổi đoạn văn hoặc phần, chỉ cần bỏ qua 1 dòng. Điều này giúp người đọc theo kịp mà không cần thêm các trang không cần thiết.

Nơi làm việc hoặc người hướng dẫn của bạn có thể cung cấp cho bạn các hướng dẫn định dạng khác nhau. Nếu vậy, hãy làm theo các hướng dẫn sau

Viết thông số kỹ thuật Bước 16
Viết thông số kỹ thuật Bước 16

Bước 2. Sử dụng quan điểm của người thứ nhất trong suốt thông số kỹ thuật của bạn

Vì bạn đang thảo luận về công việc mà bạn và nhóm của bạn sẽ hoàn thành, hãy luôn sử dụng các đại từ ngôi thứ nhất "tôi", "tôi", "chúng tôi" và "chúng tôi". Khi bạn đang đề cập đến một đội hoặc một người cụ thể, hãy sử dụng tên của họ để rõ ràng bạn đang nói về ai. Điều này giữ cho thông số kỹ thuật trực tiếp và đi vào trọng tâm vì người đọc biết cách hoàn thành mỗi hành động.

  • Ví dụ: nói, "Chúng tôi sẽ cập nhật thông số kỹ thuật khi cần thiết" thay vì "Thông số kỹ thuật sẽ được cập nhật khi cần thiết."
  • Tương tự, hãy viết "Nhóm kỹ sư sẽ viết một trang web" hoặc "Amy sẽ soạn thảo một kế hoạch tiếp thị."
Viết thông số kỹ thuật Bước 17
Viết thông số kỹ thuật Bước 17

Bước 3. Viết văn bản rõ ràng và ngắn gọn để dễ theo dõi

Đừng trình bày chi tiết ý tưởng của bạn trong một thông số kỹ thuật vì nó lãng phí cả thời gian của bạn và người đọc. Sử dụng càng ít từ càng tốt để diễn đạt ý tưởng và sắp xếp các suy nghĩ của bạn để chúng dễ theo dõi. Xem qua báo cáo của bạn và loại bỏ các từ ngữ không cần thiết và các câu lặp lại để báo cáo của bạn trực tiếp hơn.

Ví dụ: bạn có thể sửa lại "Chúng tôi sẽ viết một trang web cho phép hành khách lập kế hoạch chuyến đi mong muốn và theo dõi xe buýt" thành "Trang web này cho phép lập kế hoạch chuyến đi và theo dõi xe buýt."

Viết thông số kỹ thuật Bước 18
Viết thông số kỹ thuật Bước 18

Bước 4. Yêu cầu một đối tác xem xét thông số kỹ thuật của bạn và cung cấp phản hồi

Chia sẻ thông số kỹ thuật của bạn với một thành viên trong nhóm hoặc bạn cùng lớp, những người sẽ hiểu nó. Yêu cầu họ đánh dấu những lỗi mà họ thấy và cung cấp cho bạn phản hồi về nơi bạn có thể cải thiện.

Không hiển thị thông số kỹ thuật của bạn cho người không hiểu lĩnh vực của bạn. Họ có thể sẽ nhầm lẫn và có thể đề xuất những thay đổi không cần thiết

Viết thông số kỹ thuật Bước 19
Viết thông số kỹ thuật Bước 19

Bước 5. Sửa đổi thông số kỹ thuật của bạn nếu cần thay đổi

Dựa trên phản hồi bạn nhận được, hãy xem lại thông số kỹ thuật của bạn và thực hiện các bản sửa đổi nếu bạn cảm thấy chúng cần thiết. Tập trung vào việc làm cho thông số kỹ thuật dễ hiểu đối với khách hàng và nhóm của bạn. Tuy nhiên, đừng lo lắng rằng nó không hoàn hảo.

Bạn có thể sẽ cần cập nhật thông số kỹ thuật khi dự án hoặc sản phẩm của bạn đang tiến triển. Đây là tài liệu tạm thời, vì vậy đừng để nó ngăn cản bạn thực hiện công việc thực tế của mình

Viết thông số kỹ thuật Bước 20
Viết thông số kỹ thuật Bước 20

Bước 6. Đọc kỹ thông số kỹ thuật của bạn trước khi phân phối

Đọc qua thông số kỹ thuật của bạn ít nhất hai lần để kiểm tra lỗi. Nếu bạn có thể, hãy đọc to để giúp bạn bắt lỗi. Tập trung vào những thứ như lỗi chính tả hoặc các từ có thể thay đổi ý nghĩa tài liệu của bạn.

Ví dụ: tìm các lỗi như “hệ thống hiện tại hoạt động hiệu quả” thay vì “hệ thống hiện tại hoạt động kém hiệu quả”

Đề xuất: