LRLearning RoadmapRead, build, evaluate
Checklists

Documentation Rubric

Documentation Rubric Score each area from 0 to 4. Area Score Evidence : README explains the problem Setup instructions are reproducible Architecture is documented Evaluation is doc

rubrics/documentation-rubric.md1 min read

Documentation Rubric

Score each area from 0 to 4.

AreaScoreEvidence
README explains the problem
Setup instructions are reproducible
Architecture is documented
Evaluation is documented
Security model is documented
Trade-offs are documented
Known limitations are documented
Demo steps are clear
Commands are listed
Next improvements are listed

Strong Documentation Evidence

  • A reader can understand the project in five minutes.
  • A reader can run the project without asking questions.
  • A reader can see what was measured and what remains weak.