Làm thế nào để ghi lại một thuật toán đúng với dữ liệu mẫu?

Tôi đang tự hỏi một tài liệu thuật toán nên chứa gì? Không thể xác định một hướng dẫn thích hợp để làm theo. Tôi có ý định bao gồm

• tóm tắt thuật toán
• mô tả thuật toán
• lưu đồ
• mã giả
• tập dữ liệu đầu vào mẫu (nhiều)
• dữ liệu đầu ra
• kiểm tra đơn vị
• thí nghiệm

Khách hàng yêu cầu một tài liệu như vậy để: Duy trì sự tự tin về số lượng của chúng tôi cũng như mô tả quy trình của chúng tôi cho khách hàng tiềm năng để họ biết chúng tôi đang thực hiện các bước để kiểm tra và xác minh các tính toán của chúng tôi.

• Làm thế nào sẽ trông giống như một tài liệu như vậy? (ví dụ PDF)
• Những gì bạn sẽ bao gồm nhiều hơn trong tài liệu này?
• Những gì tôi liệt kê là tốt, hoặc điều này nên được ghi lại bằng cách nào đó?
• Làm thế nào bạn sẽ tìm kiếm trong Google cho các mẫu tài liệu như vậy?

Một số điểm khác:

1. Phân tích hiệu suất / điểm chuẩn với đầu vào mẫu và môi trường.
2. Thay thế cho thuật toán (nếu tồn tại), thực sự giúp ích cho những người mới và để phân tích so sánh.
3. Ví dụ về các tình huống / đầu vào tốt nhất và tồi tệ nhất.

Làm thế nào sẽ trông giống như một tài liệu như vậy?
Người dùng / Người dùng (/ Người quản lý?) Không thích PDF, họ thấy PPT rất thú vị, đồng thời, doanh nghiệp sẽ nhấn mạnh vào PDF. Vì vậy, bạn nên có một tài liệu hai cấp, một trong PPT chỉ để "giải thích trong 20 phút" và một tài liệu PDF khác bao gồm các chi tiết chính của trò chơi.