Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_BENCHMARK_DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Audit Checklist: Benchmark Documentation

- [ ] BENCHMARKING.md lists all benchmarks with targets
- [ ] METRICS_CURRENT.md is the single source of truth
- [ ] Each benchmark has a documented caveat
- [ ] Makefile targets exist for all benchmarks
- [ ] Benchmark gate passes
- [ ] Simulation benchmarks are up to date
8 changes: 8 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_CLAIM_WORDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Audit Checklist: Claim Wording

- [ ] `python scripts/safety/check_claims.py` reports 0 findings
- [ ] No document claims biological validation without wet-lab data
- [ ] Terms like "proven", "drug candidate", "safe in humans" are absent
- [ ] All computational results are described as predictions
- [ ] Limitations are stated alongside every major claim
- [ ] Benchmark claims reference charge-inflation caveat where relevant
7 changes: 7 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_DEAD_ENDS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Audit Checklist: Dead-End Pages

- [ ] Every page has a link back to PROJECT_INDEX.md or README.md
- [ ] No page has only "under construction" content
- [ ] Every page has at least one related document link
- [ ] External links are checked and resolve correctly
- [ ] No document has a "this page intentionally blank" pattern
7 changes: 7 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_EXAMPLE_DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Audit Checklist: Example Documentation

- [ ] All CLI examples work with current pipeline
- [ ] Example output matches actual pipeline output
- [ ] Example files in examples/ are referenced from docs
- [ ] Demo candidates produce expected results
- [ ] Synthetic data is clearly labeled as synthetic
7 changes: 7 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_GLOSSARY_DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Audit Checklist: Glossary Documentation

- [ ] All project-specific terms are defined in a glossary
- [ ] Glossary entries are consistent across documents
- [ ] Acronyms are expanded on first use
- [ ] Terms are referenced from the relevant concept cards
- [ ] Glossary is linked from PROJECT_INDEX.md
8 changes: 8 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_ONBOARDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Audit Checklist: Onboarding

- [ ] QUICKSTART.md works from a clean checkout
- [ ] CONTRIBUTING.md is up to date
- [ ] CONTRIBUTOR_CURRICULUM.md stages are accurate
- [ ] Runbooks cover the full contributor workflow
- [ ] `make demo` succeeds
- [ ] `python3 -m pytest -q` passes
8 changes: 8 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_RELEASE_DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Audit Checklist: Release Documentation

- [ ] `make full-reproducibility-report` succeeds
- [ ] `check_doc_links.py` reports 0 broken links
- [ ] `check_claims.py` reports 0 overclaiming phrases
- [ ] METRICS_CURRENT.md matches current benchmark outputs
- [ ] ROADMAP.md reflects completed work
- [ ] PUBLICATION_PACK.md checklist is complete
7 changes: 7 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_REVIEW_DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Audit Checklist: Review Documentation

- [ ] EXPERT_REVIEW_PACK.md exists and is up to date
- [ ] RELEASE_DRY_RUN_GUIDE.md matches current report output
- [ ] PUBLICATION_PACK.md checklist is complete
- [ ] Expert review template generates a valid issue
- [ ] Decision log schema is referenced where decisions are logged
8 changes: 8 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_SAFETY_DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Audit Checklist: Safety Documentation

- [ ] SAFETY.md is accurate and current
- [ ] RESPONSIBLE_USE.md covers allowed/forbidden uses
- [ ] LIMITATIONS_OVERVIEW.md includes all known limitations
- [ ] `check_claims.py` reports 0 overclaiming phrases
- [ ] All safety policies are linked from relevant docs
- [ ] Safety review template exists and is accessible
7 changes: 7 additions & 0 deletions docs/evidence/AUDIT_CHECKLIST_STALE_DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Audit Checklist: Stale Documentation

- [ ] Last update date is within 6 months for each doc
- [ ] No document references removed features or commands
- [ ] All code examples compile or run
- [ ] Deprecated documents are marked and archived
- [ ] Project INDEX.md has no dead entries
26 changes: 26 additions & 0 deletions tests/test_audit_checklists.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
"""Tests for 10 audit checklists."""
from pathlib import Path

FILES = [
"AUDIT_CHECKLIST_ONBOARDING.md",
"AUDIT_CHECKLIST_SAFETY_DOCS.md",
"AUDIT_CHECKLIST_BENCHMARK_DOCS.md",
"AUDIT_CHECKLIST_REVIEW_DOCS.md",
"AUDIT_CHECKLIST_RELEASE_DOCS.md",
"AUDIT_CHECKLIST_EXAMPLE_DOCS.md",
"AUDIT_CHECKLIST_GLOSSARY_DOCS.md",
"AUDIT_CHECKLIST_STALE_DOCS.md",
"AUDIT_CHECKLIST_DEAD_ENDS.md",
"AUDIT_CHECKLIST_CLAIM_WORDING.md",
]


def test_all_exist():
for f in FILES:
assert Path("docs/evidence", f).exists(), f"Missing: {f}"


def test_each_has_checklist():
for f in FILES:
text = Path("docs/evidence", f).read_text()
assert "- [" in text, f"{f} missing checklist items"
Loading