WIP: NDC Release 5.7.12 Documentation Update

[BenHayman-Netwrix]

No description provided.

[github-actions]

Auto-Fix Summary

72 issues fixed, 6 skipped across 6 files

Category	Fixes
Contractions	3
Substitutions	6
AllowsYouTo (rewrite)	2
CanBeUsedTo (rewrite)	2
FollowTheStepsTo (rewrite)	2
OxfordComma (rewrite)	1
Dale: exclamatory-sentences	1
Dale: passive-voice	38
Dale: undefined-acronyms	1
Dale: wordiness	16

Skipped (needs manual review)	Reason

| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangemailboxews.md:44 — Dale: positional-references | "in the bottom" refers to a physical UI location in the properties window, not to other content on the page |
| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangeserverews.md:29 — Dale: positional-references | "bottom-left corner" refers to a physical UI location, not to other content on the page |
| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangemailboxews.md:50 — Dale: wordiness | "Select Since if you want to periodically re-crawl content" — "if you want to" is the established conditional-option phrasing used consistently across all source tables; rewording one instance would break consistency |
| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/sharepointonline.md:16 — Dale: wordiness | "Templating allows an administrator to preconfigure" — multiple valid rewrites and the sentence is already direct; left to the author |
| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/sharepointonline.md:18 — Dale: positional-references | "review the associated templating guide" has no target link; adding or resolving one would require content the page doesn't provide |
| docs/dataclassification/5.7/introduction/upgrade.md:57 — Dale: wordiness | "you should run the installer as the NDC service account if possible" — the hedging is deliberate guidance; tightening it would change the strength of the recommendation |

Ask @claude on this PR if you'd like an explanation of any fix.

[github-actions]

Auto-Fix Summary

9 issues fixed, 7 skipped across 6 files

Category	Fixes
Contractions	1
Substitutions	1
Dale: misplaced-modifiers	2
Dale: passive-voice	3
Dale: wordiness	2

Skipped (needs manual review)	Reason

| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangemailboxews.md:26 — Dale: misplaced-modifiers | 'The user must have a mailbox connected to it to crawl Exchange.' — the trailing infinitive is ambiguous (whether the user or the product crawls Exchange); rewriting could change the technical meaning |
| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangemailboxews.md:9 — Dale: passive-voice | 'content stored in a single Exchange mailbox' is a reduced relative clause used consistently across all five source topics; rewriting would diverge from sibling pages without improving clarity |
| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangemailboxgraph.md:18 — Dale: passive-voice | heading text — not modified to avoid breaking anchor links |
| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangeserverews.md:10 — Dale: misplaced-modifiers | 'multiple Exchange mailboxes from the same Exchange server using the Exchange Web Services (EWS)' — 'using' could attach to the crawl action or to the server; the intended attachment is clear enough from context and any rewrite risks changing the technical claim |
| docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/sharepointonline.md:9 — Dale: passive-voice | 'SharePoint Online sites hosted in Office 365' is a reduced relative clause reading naturally as an adjective phrase; rewriting adds words without improving clarity |
| docs/dataclassification/5.7/introduction/upgrade.md:42 — Dale: wordiness | This second 'Step 4 -' block duplicates Step 3 and the following warning, and its step number collides with the Index-files Step 4 above it. Removing or renumbering it is a content/structure decision for the author, not a style fix |
| docs/dataclassification/5.7/introduction/upgrade.md:52 — Dale: wordiness | 'After taking the preceding preparatory steps' is mildly redundant, but trimming it risks losing the deliberate back-reference to the prerequisites section |

Ask @claude on this PR if you'd like an explanation of any fix.

[github-actions]

Documentation PR Review

Editorial Review

docs/dataclassification/5.7/introduction/upgrade.md

• Structure — Line 42: **Step 4 -** Stop all NDC services... duplicates the new Step 3 (line 27) and creates two steps numbered 4. The reader sees "stop all NDC services," then backs up the index, then is told to stop the services again. It also uses a hyphen (-) instead of the en dash (–) every other step uses. Suggested fix: delete line 42 entirely — Step 3 plus the new :::warning already cover the DQS instruction and the schema-failure consequence.
• Structure — Lines 37–40: after removing the duplicate, renumber so the sequence reads Step 1 (.NET), Step 2 (database backup), Step 3 (stop services), Step 4 (back up index files). Confirm the intended order — the previous version backed up the index as part of the same step that stopped the services, and stopping services first is the safer sequence, so the current order is right, only the numbering is broken.
• Clarity — Line 37: "Back up the Index files. Netwrix recommends the following:" introduces a single bullet. Suggested fix: fold it into one sentence: "Step 4 – Back up the Index files. Locate the folder containing index files (the default location is C:\Program Files\Netwrix\Data Classification\Index) and back it up."
• Completeness — Line 31: this is now the first use of "Distributed Query Server (DQS)" in the document, so line 60 ("When upgrading an NDC environment which uses the Distributed Query Server (DQS) functionality") redefines the acronym later. Suggested fix: keep the expansion at line 31 and shorten line 60 to "an NDC environment which uses DQS functionality."
• Clarity — Line 31: "make sure all services on all instances are stopped before upgrading any instance" is passive and mixed with the console instruction above it. Suggested fix: "If you are upgrading a Distributed Query Server (DQS) environment, stop the services on every instance before you upgrade any instance."

docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangemailboxews.md

• Completeness — Renaming exchangemailbox.md to exchangemailboxews.md leaves two dangling links that will fail the build (markdown links always throw): addsource.md:27 and, for the server page, addsource.md:26 and docs/dataclassification/5.7/introduction/introduction/exchange/exchange.md:97. Suggested fix: update those three links to exchangemailboxews.md / exchangeserverews.md, and add the two new Graph pages to the source list in addsource.md so readers can find them.
• Clarity — Line 10: "using the Exchange Web services (EWS)" — inconsistent capitalization (the server page uses "Exchange Web Services") and an extra article. Suggested fix: "...single Exchange mailbox on an on-premises Exchange server or in Exchange Online, using Exchange Web Services (EWS)."
• Completeness — Line 10: the page never tells an Exchange Online reader that a Graph source now exists, while both Graph pages point back to EWS. Suggested fix: add a sentence: "For Exchange Online mailboxes, Netwrix recommends Exchange Mailbox (Graph)." — or state plainly when to choose each.
• Clarity — Line 25: "Select Modern (O365)" introduces "O365" without expansion. Suggested fix: "Select Modern (O365) — the Office 365 option." Same issue on line 43 of exchangeserverews.md.
• Clarity — Lines 50, 52, 53: three field descriptions were improved here but not in the parallel Graph page, so the same fields now read differently across sibling topics ("Define the time period to crawl" vs. "Define which portions of data to retrieve"; "defaults to the global setting" vs. "defaults to the source setting (if configuring a path) or the global setting"; the new Source Group auto-creation sentence). Suggested fix: apply the same wording to exchangemailboxgraph.md lines 41, 43, and 44.

docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangemailboxgraph.md

• Clarity — Line 10: "content stored in a single Exchange mailbox on Exchange Online. Use this source type for Exchange Online mailboxes." states Exchange Online twice in consecutive sentences. Suggested fix: "Use the Exchange Mailbox (Graph) source to crawl and classify content stored in a single Exchange Online mailbox using the Microsoft Graph API. For on-premises Exchange mailboxes, use Exchange Mailbox (EWS)."
• Completeness — Line 10: "Graph" is never expanded or explained, and the EWS pages expand "Exchange Web Services (EWS)". A reader deciding between the two source types has nothing to go on. Suggested fix: expand to "Microsoft Graph API" on first use, and link "Exchange Mailbox (EWS)" rather than naming it in plain text.
• Completeness — Line 39: "Cloud Environment — Select the Azure instance hosting the Exchange Online server" doesn't say which values are available or which is the default, so the reader can't complete the field. Suggested fix: list the options as they appear in the UI (for example, Commercial, GCC High, DoD, China) and name the default. Same gap on exchangeservergraph.md:43 and sharepointonline.md:31.
• Structure — Line 39: the table row is malformed — it ends with a stray pipe and trailing spaces (| ... server. | | ) after the third column. Suggested fix: | Cloud Environment | Select the Azure instance hosting the Exchange Online server. | |
• Structure — Line 18: the heading ## Authentication has a trailing space, and it doesn't parallel the EWS pages' ## Authentication type: Modern authentication. Suggested fix: ## Authentication (no trailing space), and state in the body that Graph supports only certificate-based app authentication, so the reader understands why there is no authentication-type choice here.
• Completeness — Line 29: the page reuses the EWS screenshot (exchangeonline_cfg_modern_auth_thumb_0_0.webp), which shows an Authentication type dropdown the Graph form doesn't have and omits the new Cloud Environment field. Suggested fix: capture a screenshot of the Graph source form, or remove the image rather than show a form that doesn't match the steps. Also replace the filename alt text with a description: ![Exchange Mailbox (Graph) authentication settings](...).
• Clarity — Line 40: "E.g. test@cs.com." Suggested fix: "For example, test@cs.com."

docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangeservergraph.md

• Clarity — Line 19: "Select Exchange (Graph) source type" contradicts the title, heading, and every other mention on the page ("Exchange Server (Graph)"). A reader scanning the source list won't know which label to look for. Suggested fix: "Step 2 – Select the Exchange Server (Graph) source type and in the properties window specify the necessary settings." — or, if Exchange (Graph) is the literal UI label, use it consistently and say so.
• Clarity — Lines 10 and 44: "multiple Exchange mailboxes from the same Exchange server" and "retrieve from the Exchange server" don't fit a source that is Exchange Online only — there is no server the reader administers. Suggested fix: "...multiple Exchange Online mailboxes in the same tenant" and "Define which portions of data to retrieve from Exchange Online."
• Clarity — Line 39: "The following settings are also required:" — "also" carried over from the EWS page, where it distinguished settings shared by two authentication types. This page has one authentication section, so "also" has no referent. Suggested fix: "Specify the following settings:"
• Clarity — Line 45: "as part of an Exchange Server source" should name this source type. Suggested fix: "as part of an Exchange Server (Graph) source."
• Structure — Line 22: 'wrench' uses single quotes while the rest of the source pages use "wrench". Suggested fix: "wrench" here and on exchangeserverews.md:29.
• Completeness — Line 12: "You can use Match Rules to include or exclude specific mailboxes" appears before Match Rules is defined in the settings table at line 45, and neither place says at least one rule is required (as sharepointonline.md does). Suggested fix: state the requirement in the Match Rules row: "You must include at least one match rule."

docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/exchangeserverews.md

• Structure — Lines 33–36: the note sits under "Authentication type: Modern authentication" but describes the requirements for Email Address / Password, which belongs to the Basic authentication section (line 57). A reader configuring modern authentication will look for an Email Address / Password field that isn't there. Suggested fix: move the note under ## Authentication type: Basic, or if the permissions genuinely apply to modern authentication, rewrite it to name the field that section actually uses (Admin Username).
• Structure — Lines 12–17: :::warning is reserved for content that could cause data loss or security issues. An unsupported-version limitation is supplementary information. Suggested fix: change to :::note.
• Clarity — Line 10: "using the Exchange Web Services (EWS)" — drop the article. Suggested fix: "...from the same Exchange server, using Exchange Web Services (EWS)."
• Completeness — Lines 14–16: the warning tells the reader to "consider using the Exchange Mailbox (EWS) content source" without linking it. Suggested fix: link to exchangemailboxews.md. Consider also noting here that Exchange Online deployments can use Exchange Server (Graph).
• Structure — Line 29: **Step 3 –** To display has a double space after the en dash, and 'wrench' and Settings are unformatted where the rest of the page bolds UI labels. Suggested fix: **Step 3 –** To display all settings, click the "wrench" icon next to **Settings** in the bottom-left corner.

docs/dataclassification/5.7/contentconfigurationoverview/introduction/addsource/sharepointonline.md

• Completeness — Line 31: "Cloud Environment — Select the Azure instance hosting the SharePoint Online server" doesn't tell the reader which values to choose from or which is the default, and it's a required field on the form. Suggested fix: list the available options as they appear in the UI and name the default.
• Clarity — Line 31: the row is missing the trailing column padding used by every other row, and "the SharePoint Online server" is odd phrasing for a cloud service. Suggested fix: "Select the Azure instance that hosts your SharePoint Online tenant."
• Clarity — Line 10: "their employees SharePoint Online sites" is missing the possessive apostrophe. Suggested fix: "their employees' SharePoint Online sites."
• Clarity — Lines 10–13: the paragraph switches from third person ("Office 365 customers can configure") to second person ("You must supply...") mid-paragraph. Suggested fix: use second person throughout: "If you are an Office 365 customer, you can configure the collector service to automatically detect and queue your employees' SharePoint Online sites."

Summary

24 editorial suggestions across 6 files. The two that will block or mislead readers most: the duplicated Step 4 in upgrade.md (two steps numbered 4, telling the reader to stop services twice) and the three dangling links to the renamed exchangemailbox.md / exchangeserver.md pages, which will fail the build. Vale and Dale issues are auto-fixed separately.

---

What to do next:

Comment @claude on this PR followed by your instructions to get help:

• @claude fix all issues — fix all editorial issues
• @claude help improve the flow of this document — get writing assistance
• @claude explain the voice issues — understand why something was flagged

You can ask Claude anything about the review or about Netwrix writing standards.

Automated fixes are only available for branches in this repository, not forks.