- Content & schema
- 50tests fired in this category
- modules
- 8dedicated content & schema checks
- every scan
- 299+tests across all categories
Why it matters
A large docs folder can still leave a newcomer stranded or an experienced user searching for a simple field definition. FixWeb looks for the entry points, page forms, and maintenance signals that make public documentation usable from first success through detailed lookup.
How it works
Crawl signals inspect documentation presence, search or index paths, cross-links, visible last-updated and version labels, deprecated or archived markers, llms.txt, structured metadata or front matter, and glossary clues. A model classifies observed pages across the four Diataxis types and judges whether examples are concrete, runnable, and presented in the right form rather than in dense mega-docs.
Site impact
Missing quickstarts slow onboarding, unlinked topics create dead ends, and stale pages undermine trust. Reference without examples leaves implementation to guesswork, while a single undifferentiated mega-page is hard for both people and AI systems to navigate. The check covers public, crawlable documentation only; it cannot verify private runbooks, internal ownership, or whether code examples execute successfully.
How to improve
Publish a clear overview and getting-started path, then provide focused tutorials, task-oriented how-tos, lookup reference, and concept explanations. Add search or topic indexes and cross-links, show last-updated or version labels, mark deprecated guidance, and include runnable examples. Keep structured metadata, a useful glossary, and llms.txt where it genuinely helps machine readers.