Quality Checklist

Use this checklist before publishing any page to ensure it meets NeuroWiki standards.

Pre-Publishing Checklist

Content Requirements

Use this checklist before publishing any page to ensure it meets NeuroWiki standards.

Pre-Publishing Checklist

Content Requirements

• [ ] Minimum word count: 200+ words (500+ for important pages)
• [ ] Has overview: Clear introduction explaining what the entity is
• [ ] Has details: Substantive content beyond basic facts
• [ ] Mechanistic depth: Explains HOW, not just WHAT
• [ ] No stubs: Not just a few paragraphs

Structure Requirements

• [ ] One H1: Page title only
• [ ] Proper headings: Uses H2 for sections, H3 for subsections
• [ ] No heading gaps: Doesn't skip from H2 to H4
• [ ] Logical flow: Content organized coherently

Reference Requirements

• [ ] Has references: At least 1-2 forfactual claims
• [ ] Properly formatted: References in YAML frontmatter
• [ ] Inline citations: Uses `[@citekey]` format
• [ ] Links to sources: All PMIDs/DOIs hyperlinked

Link Requirements

• [] Internal links: Links to related NeuroWiki pages](/home)
• [] Correct paths: Uses proper path prefixes (/entities/, /diseases/)
• [ ] Proper link text: Uses entity names, not descriptions
• [ ] See Also: Links to 3-10 related pages
• [ ] No broken links: All internal links resolve
• [ ] No orphan brackets: No `[text]` without URLs

Formatting Requirements

• [ ] Valid frontmatter: Valid YAML, proper structure
• [ ] Description: 1-2 sentences (<255 chars)
• [ ] Tags: Proper section and kind tags
• [ ] No duplicates: No repeated sections or content

Technical Requirements

• [ ] Reference lint: Passes `reference_lint.py --check`
• [ ] Link lint: Passes `link_fixer.py audit`
• [ ] Mermaid valid: Any diagrams are syntactically correct
• [ ] Markdown: Valid syntax throughout

Content Quality Guidelines

What Makes a Quality Page

| Element | Good | Needs Work |
|---------|------|----------|
| Word count | 1000+ | <200 |
| References | 5+ | 0-1 |
| Internal links | 10+ | 0-2 |
| Sections | 4+ | 1-2 |
| Mechanism detail | Explains HOW | Lists facts |

Section Quality

Strong sections include:

• Specific分子 mechanisms
• Experimental evidence
• Gene/protein interactions
• Therapeutic relevance
• Current research gaps

• Just definitions
• Lists without explanation
• No citations
• No mechanisms

Common Issues to Fix

Before Publishing

After Validation

Page Type Specific

Disease Pages

• [ ] Epidemiology (prevalence, incidence)
• [ ] Pathophysiology
• [] Genetics (known genes)
• [ ] Diagnosis criteria
• [ ] Treatment options
• [ ] Current research

Gene/Protein Pages

• [ ] Basic function
• [ ] Structure
• [ ] Role in disease
• [] Related proteins](/proteins)
• [ ] Therapeutic targets

Mechanism Pages

• [ ] Molecularsteps
• [] Key proteins/genes](/proteins)
• [ ] Evidence level
• [ ] Therapeutic implications

Therapeutic Pages

• [ ] Mechanism of action
• [ ] Clinical evidence
• [ ] Side effects
• [ ] Clinical trials

Scoring Your Page

Quality Score (0-100)

• Content (40%): Word count, depth
• References (35%): Number, quality
• Links (25%): Internal cross-links

Target Scores

| Page Type | Minimum | Good | Excellent |
|----------|--------|------|----------|
| Disease | 50 | 75 | 90+ |
| Gene/Protein | 40 | 70 | 85+ |
| Mechanism | 50 | 75 | 90+ |
| Therapeutic | 45 | 70 | 85+ |

Quick QA Commands

Validate references

Validate links

Validate markdown

Audit quality

See Also

• [Changelog Format Guide](/Meta/changelog-format-guide)](/Meta/changelog-format-guide)
• [Content Contribution Guide](/Meta/content-contribution-guide)](/Meta/content-contribution-guide)
• [Editing Standards](/Meta/editing-standards)