Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Google Phần Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- SymPy
- Người viết nội dung kỹ thuật:
- đồng thời
- 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 lượng tiêu chuẩn (3 tháng)
Mô tả dự án
Đối với dự án này, tôi mong muốn các chuỗi tài liệu của SymPy có tính nhất quán cao hơn.
Làm việc với người cố vấn của mình, 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 tài liệu trên cơ sở mã cần tuân theo. Dự án này cũng bao gồm cả 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 các vấn đề không thống nhất khác như việc sử dụng ngôn ngữ hoặc thuật ngữ. Tôi và các cố vấn của mình sẽ cùng nhau đưa ra các quyết định biên tập về cách xử lý những mâu thuẫn bổ sung này, đồng thời các lựa chọn ưu tiên về văn phong cũng sẽ được thêm vào tài liệu hướng dẫn.
Mục tiêu cuối cùng của dự án là định dạng và định dạng tài liệu để cả nhà phát triển và người đóng góp đều có thể sử dụng nhằm duy trì tính nhất quán trong các chuỗi tài liệu của SymPy cả ở hiện tại và trong tương lai.