Câu hỏi được gắn thẻ «documentation»

2

Ngôn ngữ phổ biến - xung đột giữa tính chính xác và khả năng sử dụng

Một phần cốt lõi của Thiết kế hướng miền là việc sử dụng nhất quán ngôn ngữ phổ biến trên toàn hệ thống - trong các cuộc hội thoại, mã, lược đồ cơ sở dữ liệu, giao diện người dùng, kiểm tra, v.v. Tôi đang tham gia vào một dự …

10 documentation  domain-specific-languages 

---

13

Bạn có thể viết một đặc tả rõ ràng bằng một ngôn ngữ tự nhiên như tiếng Anh không?

Đối với tôi, dường như bạn không thể viết một đặc tả phần mềm bằng tiếng Anh hoàn toàn không có sự mơ hồ, đơn giản là do bản chất không chính thức của ngôn ngữ tự nhiên - và do đó, một đặc tả thực sự rõ ràng phải …

10 documentation  specifications 

---

5

Mã tài liệu: Công khai so với không công khai?

Tôi là một trong những nhà phát triển có suy nghĩ rằng mã được viết nên tự giải thích và đọc như một cuốn sách. TUY NHIÊN, khi phát triển mã thư viện cho người khác sử dụng, tôi cố gắng đưa càng nhiều tài liệu vào các tệp tiêu …

10 c++  documentation 

---

6

Nó có làm cho tôi trở thành một lập trình viên tồi nếu tôi không thích phương pháp Agile không? [đóng cửa]

Thật khó để nói những gì đang được hỏi ở đây. Câu hỏi này là mơ hồ, mơ hồ, không đầy đủ, quá rộng, hoặc hùng biện và không thể được trả lời một cách hợp lý trong hình thức hiện tại của nó. Để được giúp làm rõ câu …

10 agile  documentation  methodology 

---

5

Tài liệu tham khảo tốt cho các ví dụ về tài liệu Người dùng Cuối và tư vấn [đã đóng]

Đã đóng cửa. Câu hỏi này không đúng chủ đề . Nó hiện không chấp nhận câu trả lời. Bạn muốn cải thiện câu hỏi này? Cập nhật câu hỏi để nó thuộc chủ đề cho Trao đổi ngăn xếp kỹ thuật phần mềm. Đóng cửa 6 năm trước . …

10 design  documentation  users 

---

1

Doxygen có hỗ trợ các mẫu cho đầu ra HTML không?

Tôi đã ghi lại mã của mình doxygen, nhưng tôi không muốn HTML mặc định. Tôi biết tôi có thể tùy chỉnh nó bằng cách cung cấp CSS tùy chỉnh, tiêu đề, chân trang, v.v. (như Gnome) và cách tôi có thể thêm mã PHP phổ biến vào các tệp …

10 documentation  templates  documentation-generation 

---

1

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ữ …

10 java  php  algorithms  documentation  sql 

---

5

Cách tốt nhất để lưu trữ tài liệu liên quan đến một dự án mã là gì?

Chúng tôi có rất nhiều tài liệu liên quan đến phát triển phần mềm của chúng tôi. Chúng bao gồm những thứ như yêu cầu, tài liệu thiết kế, tệp PDF bên ngoài, tệp khách hàng, hướng dẫn kiểm tra, v.v. Hiện tại, các tài liệu này nằm rải rác …

10 version-control  documentation 

---

1

Áp dụng độ chính xác của các hàm dấu phẩy động

Trong khi xem xét việc triển khai hàm của một lập trình viên khác để tính toán CDF phân phối bình thường , tôi đã đưa ra một đề nghị thay thế toàn bộ việc thực hiện bằng các hàm dựng sẵn của Python hoặc sử dụng SciPy, một thư …

9 documentation  math  floating-point  numeric-precision 

---

3

Có phải là thực tế xấu để thêm các liên kết bên ngoài trong tài liệu?

Thường thì tôi thấy mình giải quyết các lỗi bằng cách tìm câu trả lời trên Stack Overflow. Có phải là một thực tế xấu khi thêm một đoạn lý do tại sao tôi đã làm những gì tôi đã làm và sau đó thêm một liên kết đến một …

9 documentation 

---

1

Cách giữ các ví dụ mã trong javadocs cập nhật

Tôi đang làm việc trên một thư viện nhỏ cung cấp việc triển khai các số liệu chuỗi cơ bản, nổi tiếng. Chủ yếu là cho giáo dục của riêng tôi. Vì vậy, sự phát triển xảy ra bất cứ khi nào tôi có một chút thời gian rảnh rỗi. …

9 java  documentation  javadocs 

---

6

Siêu liên kết, tài liệu mã nguồn bên ngoài [đóng]

Đã đóng cửa . Câu hỏi này cần được tập trung hơn . Nó hiện không chấp nhận câu trả lời. Bạn muốn cải thiện câu hỏi này? Cập nhật câu hỏi để nó chỉ tập trung vào một vấn đề bằng cách chỉnh sửa bài đăng này . Đóng …

9 development-process  documentation  source-code 

---

4

Chúng ta có nên tìm kiếm mã nói dối?

Điều này đề cập đến một cuộc thảo luận trong một câu trả lời và ý kiến ​​của câu hỏi này: Điều gì có ác cảm với tài liệu trong ngành? . Câu trả lời cho rằng "mã không thể nói dối" và do đó nên là vị trí đi …

9 documentation 

---

3

Làm thế nào để tham khảo các lĩnh vực cụ thể của mã trong tài liệu?

Tôi sắp rời khỏi một dự án, và trước khi tôi đi, sếp của tôi đã yêu cầu tôi viết mã tài liệu (Tôi chưa làm tài liệu tốt lắm). Đó không phải là một vấn đề lớn, dự án không quá phức tạp. Nhưng tôi đang tìm địa điểm …

9 documentation  comments 

---

3

Làm thế nào để bạn theo dõi các quy tắc kinh doanh phức tạp bên ngoài mã?

Tôi quan tâm đến việc xem người khác làm điều này như thế nào. Đặc biệt trong các tình huống có nhiều khách hàng khác nhau đang sử dụng cùng một cơ sở phần mềm với các quy tắc kinh doanh hơi khác nhau. Những loại thực hành nào bạn …

9 documentation  business-rules 

---