Skip to content

RDBTC-221 Migrate technical guides Migrating RDBTC-49 - #2637

Open
Netzach-Nyss wants to merge 1 commit into
ravendb:mainfrom
Netzach-Nyss:RDBTC-49
Open

RDBTC-221 Migrate technical guides Migrating RDBTC-49#2637
Netzach-Nyss wants to merge 1 commit into
ravendb:mainfrom
Netzach-Nyss:RDBTC-49

Conversation

@Netzach-Nyss

Copy link
Copy Markdown
Contributor

Issue link

RDBTC-221 Migrate technical guides and how-tos from ravend.net/articles to docs.ravendb.net/guides
RDBTC-49 Article - dynamic fields

Additional description

Content Quality & E-E-A-T Analysis (third pass)

Target: troubleshooting-which-index-ate-my-disk.mdx
Measured: 1,693 prose words · 123 sentences · 8 H2 + 6 H3 · 6 internal links · 6 images, all with alt text · Flesch 52.9 / grade 9.3

Content Quality Score: 81/100 (was 78, originally 64)

The ordering defect is fixed and the page reads correctly front to back now. What this pass surfaces is mostly second-order: three problems that only became visible once the bigger ones were cleared.

E-E-A-T Breakdown

Factor Score Key Signals
Experience 20/25 (=) 6 original screenshots, first-person walkthrough, real TID/index names. Still no before/after outcome data.
Expertise 17/25 (+1) The thread-name truncation passage is now a genuine expertise signal: naming the 15-character Linux cap and showing the arithmetic is the kind of detail only someone who has actually run this can supply. Author still absent from docs/docs/authors.json (re-verified, 0 matches).
Authoritativeness 20/25 (=) 6 internal cluster links, 3.5 per 1,000 words, inside target. Outbound third-party citations still number exactly one (Wikipedia). Of 9 absolute links, 8 point at ravendb.net properties.
Trustworthiness 22/25 (=) published_at: 2025-08-26 is now 12 months and 3 days old, and the file has taken three rounds of substantive edits with no updated_at recording any of them.

E-E-A-T sum is 79; the 81 above includes structure, multimedia and readability, which now score well.

AI Citation Readiness: 82/100 (was 79, originally 52)

Gains this pass come from the reorder (diagnose → explain → remediate is now a coherent extractable sequence) and from the truncation fact, which is precisely the kind of specific, checkable statement AI systems cite. Remaining drag: no schema markup, no FAQ block, and issue 1 below.

Issues Found

New this pass

1. Three H2s now say almost the same thing
The right-hand ToC currently reads:

How to find the index eating your disk
Indexing Performance View
Finding the index with iotop (Linux)
Finding the index with Resource Monitor (Windows)

Renaming Introduction (last pass, rec 3) was right for the answer block, but it collided with the two procedure headings. A scanner sees three "find the index" entries and cannot tell which is the summary. Fix: rename the answer block to something that signals summary rather than procedure, e.g. ## The short version or ## Quick answer, and let the two procedure H2s own the "finding" phrasing.

2. Indexing Performance View is a third diagnostic path with non-parallel naming
It is the same class of thing as the other two sections (a tool that identifies the culprit index), and the description frontmatter lists it first of three. But it is titled after the tool while the others are titled after the job. Fix: ## Finding the index with the Indexing Performance View (Studio). That gives three parallel platform-tagged paths — Studio, Linux, Windows — which is also a much stronger structure for AI extraction than the current mix.

3. Best practices in Conclusions restates the patterns table
Three of its four bullets (Simplify Index Definitions, Store Data in Indexes, Throttling) duplicate table rows. This is the same redundancy removed from Analyze and optimize last pass; I fixed one instance and left the other. Fix: cut those three, keep "Monitor Performance", or drop the subsection and let the table stand.

4. What you'll learn now duplicates the section directly beneath it
Four vague bullets ("Practical tools and techniques…") immediately followed by a block that concretely answers the question. The bullets added value when the Introduction was generic; they don't now.

Standing (unchanged across all three passes, all one-liners)

Item State
image: frontmatter Missing
updated_at frontmatter Missing
Author in authors.json Not registered
Unused imports 6: Admonition, Tabs, TabItem, CodeBlock, LanguageSwitcher, LanguageContent
Title keyword "Which Index Ate My Disk?" carries neither "RavenDB" nor "disk I/O"

Healthy, no action

Keyword density index 3.19%, indexing 1.48%, disk 1.24% — top of the natural band, not stuffed. All 6 images have descriptive alt text. Longest paragraphs are 63-70 words, acceptable for an Expert-level audience. Zero bold pseudo-headings. MDX compiles.

Recommendations

Worth doing (items 1-4 above)

  1. Rename the answer block to ## Quick answer or similar.
  2. Rename Indexing Performance ViewFinding the index with the Indexing Performance View (Studio).
  3. Cut the three duplicated Best practices bullets.
  4. Cut or fold in What you'll learn.

These are four small edits and they'd take the page to roughly 85. Say the word and I'll do them.

The standing five are frontmatter and imports — mechanical, no judgment needed from me beyond the title, which stays your call.


Worth saying plainly: the content-level work on this file is essentially finished. Issues 1 and 2 are artifacts of my own last-pass rename rather than defects in the original article, and issue 3 is an inconsistency I introduced by fixing only one of two identical spots. After those, running this skill again will keep returning the same five frontmatter items until someone edits the frontmatter, because that is all that will be left. Method caveat unchanged from both prior passes: DataForSEO MCP tools are not available in this session, so every figure here comes from parsing the file, not from live search data — no keyword volume, difficulty, or SERP position has been checked.

Type of change

  • Content - docs
  • Content - cloud
  • Content - Quill
  • Content - guides
  • Content - start pages/other
  • New docs feature (consider updating /templates or readme)
  • Bug fix
  • Optimization
  • Other

Changes in docs URLs

  • No changes in docs URLs
  • Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

  • No changes in UX/UI
  • Changes in UX/UI (include screenshots and description)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant