exercism / exercism/docs

How-to Docs: Creating a new concept

Đang mở
#370 0 bình luận 2 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
52
Fork
98
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

We have the "spec" style documentation about what is in a concept once it is done but we don't have a document about how to approach creating a new concept from scratch.

Some notes on what could be mentioned:
- Making sure the new concept fits the concept tree
- work off an existing issue or open an issue to discuss with maintainers first before jumping in
- think about where the concept will sit in the tree and what prerequisites can be assumed when writing the introduction content
- Collect/read some resources on the concept if you are not yet super familiar with the concept
- If not provided in the issue, think about the learning objectives of the concept and what is out-of-scope
- If the topic is somewhat larger, think about the subsections it might have
- The empty file is the biggest enemy, start by writing a very bad draft and iterate from there
- Only writing the introduction.md version first and using it also as about.md can help to build up a syllabus more quickly, more advanced content can always be added to the about file later on.
- Make sure to keep the introduction minimal

(I am not sure how to ensure that content is not duplicated between this document and the spec style document we already have. Some content would fit both document. We might need to think a bit more about how to draw the line/how they work together.)

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

Đánh giá

Issue này chưa được đánh giá.

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.