Skip to content
oss-kit
Install

Documentation

Documentation holds 10 of the standard’s 61 rules. Each one names the evidence that settles it and the skill that fixes it.

  1. R-DOC-01The README opens with one sentence saying what the project doesoss-readmeGitHub and GitLab
  2. R-DOC-02The README shows how to install the project and one runnable example, in that order, near the toposs-readmeGitHub and GitLab
  3. R-DOC-03The README links to the license, the changelog, and the contributing guideoss-readmeGitHub and GitLab
  4. R-DOC-04Every version, command, and support claim in the README matches the repositoryoss-readmeGitHub and GitLab
  5. R-DOC-05Documentation prose is plain, active, and free of marketing languageoss-writingGitHub and GitLab
  6. R-DOC-06The README names what the project covers and where it runsoss-readmeGitHub and GitLab
  7. R-DOC-07Every fenced code block in the README says what consumes itoss-readmeGitHub and GitLab
  8. R-DOC-08The README links a public place to ask a question and report a problemoss-readmeGitHub and GitLab
  9. R-DOC-09The README says whether the project is maintainedoss-readmeGitHub and GitLab
  10. R-DOC-10The README names one thing that sets the project apart, with evidenceoss-readmeGitHub and GitLab