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 Phần Google 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:
- lột xác
- 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 gian tiêu chuẩn (3 tháng)
Mô tả dự án
Đối với dự án này, tôi muốn mang đến tính nhất quán cao hơn cho các chuỗi tài liệu của SymPy.
Khi làm việc với người 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 hướng dẫn định dạng tài liệu cho tất cả các chuỗi tài liệu trong cơ sở mã cần tuân theo. Trong dự án này, tôi cũng sẽ 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 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 điểm không thống nhất này và kết quả là 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 tài liệu và hướng dẫn văn phong để cả nhà phát triển và người đóng góp 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à sau này.