123ishaTest / 123ishaTest/igt-docs

Headline "Requirements" aren't requirements, but features

Đang mở Phù hợp với người mới
#2 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
JavaScript
Star
5
Fork
1
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

I was confused reading the docs where the subheadline of feature pages say "Requirements" but the list under it is a list of use cases, not requirements. Since `Feature` is already a class name in the tool (and so is `Requirements` for that matter), what about changing this headline to "Purpose" or "Benefits", "Advantages", "Properties", "Traits", etc. or something like that?

Example:

image

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Look at the documentation pages for features in the project, likely in the docs/ directory. Find where the 'Requirements' headline is used and change it to a more accurate term like 'Purpose' or 'Benefits'. Verify the change by checking the rendered documentation locally or in a preview.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
85/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.