Làm thế nào để tôi viết một đặc tả chức năng một cách nhanh chóng và hiệu quả

Vì vậy, tôi chỉ đọc một số bài viết tuyệt vời của Joel về thông số kỹ thuật ở đây . (Được viết vào năm 2000 !!) Tôi đã đọc tất cả 4 phần, nhưng tôi đang tìm kiếm một số phương pháp có phương pháp để viết thông số kỹ thuật của mình.

Tôi là nhà phát triển cô đơn duy nhất, làm việc trên ứng dụng khá phức tạp này (hoặc gia đình ứng dụng) cho một công ty tài chính rất nổi tiếng.

Tôi chưa bao giờ làm điều gì đó nghiêm trọng như vậy, tôi bắt đầu viết một cái gì đó giống như một thông số xấu, tổng quan về một số loại, và nó đã lãng phí rất nhiều thời gian của tôi.

Tôi cũng đã thực hiện 3 điều mô phỏng cho khách hàng của mình để tôi hiểu rõ về những gì họ muốn. Cũng đã phát hành bản xem trước (một ứng dụng làm việc vứt đi với quy trình làm việc cơ bản nhất) và tôi chỉ viết và thử nghiệm một số hệ thống cơ bản / cốt lõi.

Tôi nghĩ rằng lỗi tôi đã mắc phải cho đến nay là không viết một thông số kỹ thuật chi tiết, vì vậy bây giờ tôi đang mắc phải nó.

Vì vậy, toàn bộ bao gồm

• Một trang web MVC (để quản trị viên & xem dữ liệu)
• 2 mô-đun Silverlight (Dành cho 2 nhiệm vụ cụ thể)
• 1 ứng dụng máy tính để bàn

Tôi hoàn toàn thiếu thời gian, tài nguyên và cần phải hoàn thành công việc này một cách nhanh chóng, đồng thời, cần đảm bảo rằng những người này đọc nó nhanh chóng và không đau đớn.

• Vì vậy, làm thế nào để tôi đi về nó, tôi đang tìm kiếm bất kỳ lời khuyên, bất kỳ công cụ trong thế giới thực, làm thế nào để các bạn thường làm điều đó?
• Bạn có tạo một màn hình giả của mỗi hộp thoại / biểu mẫu / trang không?

Tôi đang nghĩ đến việc tạo một dự án ASP.NET Web Forms giả, sau đó điền các tệp HTML vào các thư mục và làm cho nó trông giống như cấu trúc URL MVC của tôi.

Sau đó, có một phần trong thông số kỹ thuật cho trang web và viết một trang cho mỗi URL tôi có với một màn hình.

Đối với ứng dụng win form của tôi, tôi đã thực hiện một phần của dự án Win Form demo, sau đó tôi sẽ đặt một hộp thoại hoặc cấu trúc mọi thứ như trong ứng dụng thực và sau đó chụp màn hình?

Đối với một số nền tảng cho câu hỏi này. Tôi luôn luôn là một anh chàng nhảy mã điên cuồng, hoạt động tốt, nhưng đối với ứng dụng tôi đang làm việc, nó không chỉ phức tạp, nó còn dành cho một công ty rất có uy tín và lớn và tôi phải có được nó đúng!

(Và nó đã diễn ra tốt đẹp cho đến nay, hôm nay tôi đã đưa ra một bản demo của phiên bản xem trước mà rất nhiều người thích !! = D)

Nếu tôi có được thiết kế ban đầu, tôi cũng sẽ có một doanh nghiệp tuyệt vời với công ty này, đã có nhiều suy nghĩ về các tính năng "tuyệt vời" mới mà họ sẵn sàng trả tiền.

Bạn đã đọc phần 2 của bài viết hoặc đặc điểm kỹ thuật mẫu của anh ấy ? Họ thể hiện một vài nguyên tắc quan trọng khi viết một đặc tả.

• Đừng quá tin tưởng. Mục đích của việc viết thông số kỹ thuật là buộc bạn phải suy nghĩ về những điều quan trọng như những gì xảy ra khi có lỗi và cách bạn mong đợi người dùng tương tác với hệ thống. Bạn không cần phải đi sâu vào chi tiết để có được thứ gì đó bạn có thể làm việc. Bạn cần chi tiết, mặc dù.
• Đó là về giao tiếp. Mục đích của thông số kỹ thuật là đi đến một thỏa thuận chung về những gì cần phải làm. Đó không phải là một tài liệu bằng sắt đòi hỏi phải có lực lượng pháp luật. Đó là một công cụ giúp bạn hiểu rõ hơn về khách hàng của mình và khách hàng của bạn để hiểu rõ hơn những gì bạn muốn làm cho họ.

Lời khuyên tốt nhất là viết đủ để bạn rõ ràng về những gì bạn cần làm. Nếu bạn có câu hỏi mở, hãy ghi lại chúng trong thông số kỹ thuật và nhận câu trả lời từ khách hàng của bạn. Một khi bạn hiểu đầy đủ những gì cần thiết dừng lại .

Nếu bạn không cẩn thận, tài liệu sẽ có một cuộc sống riêng. Nó nên có một mục đích, không thêm bất cứ điều gì vào tài liệu không phù hợp với mục đích đó. Nó nên dễ dàng để duy trì. Nếu bạn có toàn bộ sơ đồ lớp chi tiết của mình trong đó cùng với các chi tiết khác thực sự thuộc về bài kiểm tra đơn vị, bạn sẽ từ bỏ tài liệu vì bảo trì quá nhiều hoặc bạn sẽ không bao giờ hoàn thành dự án.

Về viết lách

Viết cho mọi người là khó . Trong thực tế, hai điều khó nhất khi viết là biết bắt đầu và biết khi nào nên dừng lại . Ban đầu bạn chỉ cần làm một cái gì đó. Lời khuyên của tôi để đối phó với hai khía cạnh khó khăn nhất là:

• Biết khán giả của bạn. Ai có nghĩa vụ phải đọc thông số kỹ thuật? Nếu đó chỉ là bạn và khách hàng, thì đó là người bạn đang viết cho. Nếu bạn có ai đó chịu trách nhiệm kiểm tra, bạn cũng sẽ có một số lưu ý cho họ.
• Bắt đầu với điều ưu tiên cao nhất. Mặc dù xác thực là quan trọng, màn hình đăng nhập có lẽ là phần được hiểu rõ nhất mà hầu hết mọi người phải viết. Thay vào đó tập trung vào tính năng mà người dùng của bạn cần nhất. Bạn biết đấy, phần đó giúp họ kiếm tiền và là toàn bộ lý do họ cần phần mềm.
• Điền chi tiết khi các câu hỏi xuất hiện và bạn nhận được câu trả lời. Giữ mọi thứ thực sự đơn giản với bản vẽ khăn ăn nếu cần thiết cho đến khi khách hàng hài lòng với sự sắp xếp. Điều quan trọng là phải biết thông tin nào có liên quan và cách họ sẽ sử dụng thông tin đó.
• Dừng lại khi thêm nhiều hơn không thêm giá trị. Có một số chi tiết bạn không muốn trong một thông số kỹ thuật. Bạn cần biết khi nào bạn có điều đúng. Bạn không cần phải biết rằng có một biến trong một phương thức có tên là "alba Stew". Đó là mã nguồn, không phải thứ đặc tả.