Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- SymPy
- Người viết nội dung kỹ thuật:
- lglattly
- Tên dự án:
- Tính nhất quán giữa các chuỗi tài liệu
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Đối với dự án này, tôi muốn mang lại sự nhất quán hơn cho các chuỗi tài liệu của SymPy.
Làm việc với các cố vấn, trước tiên, tôi sẽ xác định định dạng mong muốn cho một chuỗi tài liệu trong cơ sở mã. Sau đó, tôi sẽ tạo một hướng dẫn định dạng tài liệu cho tất cả các chuỗi ký tự mô tả trên cơ sở mã để làm theo. Trong dự án này, công việc của tôi cũng bao gồm việc triển khai hướng dẫn mới để cập nhật các chuỗi tài liệu hiện có, đồng thời thu thập và giải quyết những điểm không thống nhất khác như cách sử dụng ngôn ngữ hoặc các thuật ngữ. Tôi và các cố vấn sẽ cùng nhau đưa ra quyết định biên tập về cách xử lý những điểm không nhất quán khác này. Các lựa chọn ưu tiên về phong cách sau đó cũng sẽ được thêm vào hướng dẫn.
Mục tiêu cuối cùng của dự án là một hướng dẫn về định dạng và phong cách tài liệu mà cả nhà phát triển và cộng tác viên đều có thể sử dụng để giúp duy trì tính nhất quán trong docstring của SymPy hiện tại và trong tương lai.