Skip to content

RDBTC-221 Migrate technical guides Migrating RDBTC-108 - #2632

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

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

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-221 Migrate technical guides and how-tos from ravend.net/articles to docs.ravendb.net/guides

Additional description

Content Quality Score: 86/100 (was 81, 64 at first pass)

Metrics are now healthy across the board: 1,760 prose words, average sentence 18.5 (target 15-20), 2.8 sentences per paragraph (target 2-4), no keyword stuffing, zero duplicate paragraphs across 39 checked. The five fixes landed and I found no regressions.


E-E-A-T Breakdown

Factor Score Change Key Signals
Experience 20/25 +1 The new sizing rule is the gain: "check the storage report" ties the recommendation to a first-party signal the guide already taught the reader to read, rather than an invented number. Still no timings or throughput figures anywhere.
Expertise 19/25 = Flat, and the reason is the resumability row still sitting in the table. Everything else reads as accurate.
Authoritativeness 22/25 = Unchanged and near the practical ceiling: 10 internal links, descriptive anchors, all resolving to current 7.2 docs.
Trustworthiness 19/25 = Flat. The missing revision date is the whole gap now, and it grows every time the page is edited without one.

Total: 80/100 (was 79, 74 at first pass)

E-E-A-T barely moved because this round was polish and accessibility, which those four factors do not register. That is the expected shape, not an underperformance.


AI Citation Readiness: 80/100 (was 78, 55 at first pass)

The labelled table header measurably helps machine parsing (a column with no header name is harder to attribute), and the sizing cell is now a quotable rule rather than a vague adjective. Remaining gaps are unchanged: no FAQ, no statistics, no freshness signal, author entity still a stub.


Issues Found

The list is short now, and everything on it is already known to you.

High

1. The resumability row is still in the table. | Resumable if interrupted | Yes | No | Yes |. The Yes for Export & Import is my unsourced claim, unsupported by the 7.2 docs in either direction, and Export & Import is restartable rather than resumable. This is the only correctness problem on the page and the only thing holding Expertise flat.

Medium

2. No image: frontmatter. Deferred twice now. Guide card and OG preview fall back to a default.

3. No revision date. published_at: 2025-05-14, unchanged, on a page that has now been through three editing rounds. This is the single cheapest remaining fix and the one with the clearest E-E-A-T return.

4. No FAQ block. Three extractable questions are answered in the body but never surfaced as questions.

Low

5. The head term is thin in the body. "Migrate" or "migration" appears 4 times in 1,760 prose words (0.2%), and no H2 contains it. Title, H1, and first 100 words all carry it, which are the three placements that matter most, so this is a minor point. Semantic variations (export, import, replication, move) are dense and natural. If you want a cheap lift, the summary bullets say "moving" where they could say "migrating", and "Before you start" could become "Before you migrate". I would not restructure the voice-first H2s for this.

6. Author entity is still a stub. "Technical Writer", default placeholder avatar, no bio, no URL, no socials. This is an authors.json fix, not a page fix, and it affects every guide by this author rather than just this one.


Recommendations

  1. Resolve the resumability row. Drop it, or narrow it to what the article supports. Your call on the product behavior, and I would rather delete the row than guess again.
  2. Add a revision date and image: frontmatter. Two lines of frontmatter, and together they close most of the remaining Trustworthiness gap.
  3. Add a three-question FAQ before the summary if you want the last meaningful AI-citation gain.

Items 1 and 2 would put content quality around 90 and E-E-A-T around 84. Items 5 and 6 are optional and I would not prioritize either.

There is diminishing return from further passes on this file. After the resumability row and the frontmatter, I would call it done and point the same treatment at another guide.

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