Writing Conventions for Markdown-based Docs

Đang mở
  • Có gì không ổn?
#35 1 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Issue không nêu tên tệp hoặc bài kiểm thử nào trong repository. Hãy bắt đầu bằng cách xem xét tài liệu hiện có dựa trên Markdown và các tài liệu tham khảo về quy ước O'Reilly được liên kết, sau đó xác định nơi nên đặt hướng dẫn viết áp dụng cho toàn dự án. Được xem là hoàn thành khi có một quy ước đã được thống nhất và một quyết định được ghi lại, nhưng issue không định nghĩa kết quả đó.

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

Mô tả

discuss help wanted question

When writing a "how-to" (e.g: learn-xyz) or general project documentation, should we have a list of writing conventions the way O'Reilly books (the benchmark for tech books) always have a "Conventions Used in This Book" section at the start of the book e.g: http://www.oreilly.com/openbook/debian/book/prf1_02.html

Terminal Commands

When instructing people to run a certain command in the Terminal (Emulator), should we

  • include the $ (dollar sign) in front of the command (or not) ? #discuss
  • explicitly state that the command has to be run in the terminal?
  • use constant width bold for all "Commands or text to be typed by the user" ?

For a complete list of the O'Reilly Typography and Font Conventions
see: http://chimera.labs.oreilly.com/books/1230000000969/ch03.html
PDF Snapshot: O'Reilly-Typography-and-Font-Conventions.pdf

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
92
Fork
9
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của dwyl/contributing

Tất cả issue của dwyl/contributing

Issue tương tự

Thêm issue về Documentation

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.