Skip to content

Add Required Permissions section to Host Inventory docs - #1311

Open
tay-caliguiri wants to merge 2 commits into
devfrom
naa-host-inventory-lpm-doc
Open

Add Required Permissions section to Host Inventory docs#1311
tay-caliguiri wants to merge 2 commits into
devfrom
naa-host-inventory-lpm-doc

Conversation

@tay-caliguiri

Copy link
Copy Markdown
Contributor

Documents the per-property-group permission requirements (Remote Registry, WMI, AD) for the host inventory process

Documents the per-property-group permission requirements (Remote Registry, WMI, AD) for the host inventory process, carried over from the staged LPM draft.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

The two files receive identical additions — a new Required Permissions section appended to the end of each. The same issues apply to both; line numbers differ slightly because 11.6 is offset by one line.

docs/accessanalyzer/12.0/admin/settings/hostinventory.md

  • Completeness — Lines 183–204: The section refers to "the account used" and "the account used for host inventory" repeatedly but never identifies which account this is or where it is configured. A newer administrator reading this is left with the immediate question "which account, and where do I set it?" Suggested fix: add a cross-reference to the topic where the host inventory account/credentials are configured, or a brief sentence naming the credential setting these permissions apply to.
  • Clarity — Lines 207–209: "the properties ... are expected to be left blank rather than causing the entire host inventory record to fail" hedges on the product's actual behavior. Documentation should state behavior definitively. Suggested fix: "the properties normally supplied by the denied mechanism are left blank rather than causing the entire host inventory record to fail."
  • Completeness — Line 189 (also 195): "WMI" is used throughout without being spelled out on first use, and "IIS" appears on line 187. Netwrix standards require acronyms to be expanded on first use for readers new to the product. Suggested fix: change the first occurrence to "Windows Management Instrumentation (WMI)" and expand IIS on first use (for example, "IIS (Internet Information Services)").
  • Structure — Line 181: "the four property groups above" points back to the Inventory Items list near the top of the document (lines 15–20), separated from this section by the entire Default Host Lists section. A reader who lands on Required Permissions may not recall that reference. Suggested fix: link back to the Inventory Items section, or briefly re-name the four groups (Operating System, Application, Network, Hardware) in the intro sentence so the section stands on its own.

docs/accessanalyzer/11.6/admin/settings/hostinventory.md

  • Completeness — Lines 184–205: Same as 12.0 — "the account used" is never identified or tied to where it is configured. Suggested fix: add a cross-reference to where the host inventory account/credentials are set.
  • Clarity — Lines 208–210: Same as 12.0 — "are expected to be left blank" hedges on actual behavior. Suggested fix: "are left blank rather than causing the entire host inventory record to fail."
  • Completeness — Line 190 (also 196): "WMI" is not spelled out on first use, and "IIS" appears on line 188. Suggested fix: expand both on first use — "Windows Management Instrumentation (WMI)" and "IIS (Internet Information Services)."
  • Structure — Line 182: "the four property groups above" references content near the top of the document. Suggested fix: link back to the Inventory Items section or re-name the four groups in the intro sentence.

Summary

4 editorial suggestions per file across 2 files (the same 4 issues, since the additions are identical). No structural blockers. 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.

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

50 issues fixed, 4 skipped across 2 files

Category Fixes
Contractions 14
Substitutions 16
FormalHedging (rewrite) 2
Idioms (rewrite) 2
Dale: passive-voice 14
Dale: positional-references 2
Skipped (needs manual review) Reason
docs/accessanalyzer/11.6/admin/settings/hostinventory.md:75 — Netwrix.DesiredAsAdjective 'The Desired Host List Views' is the literal, capitalized name of a UI section; rewording it would misname the interface element and break accuracy.
docs/accessanalyzer/12.0/admin/settings/hostinventory.md:74 — Netwrix.DesiredAsAdjective 'The Desired Host List Views' is the literal, capitalized name of a UI section; rewording it would misname the interface element and break accuracy.
docs/accessanalyzer/11.6/admin/settings/hostinventory.md:189 — Dale: undefined-acronyms WMI, IIS, SQL, AD, and API are standard Windows/IT terms a sysadmin audience knows; the undefined-acronyms rule excludes well-known industry acronyms
docs/accessanalyzer/11.6/admin/settings/hostinventory.md:42 — Dale: passive-voice Pre-existing content outside the changed section ('will be queried', 'will be designated as being offline'); left as-is to keep the fix scoped to the newly added Required Permissions section

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

@tay-caliguiri tay-caliguiri added the access-analyzer This change or issue involves Access Analyzer. label Aug 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

access-analyzer This change or issue involves Access Analyzer.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants