Skip to content

Update subscriptions documentation for Auditor 10.8#1026

Open
pavelshabanov2025 wants to merge 2 commits into
devfrom
pt4/pshabanov/create_subscriptions
Open

Update subscriptions documentation for Auditor 10.8#1026
pavelshabanov2025 wants to merge 2 commits into
devfrom
pt4/pshabanov/create_subscriptions

Conversation

@pavelshabanov2025
Copy link
Copy Markdown
Contributor

Summary

  • Rewrote create.md: added overview and prerequisites sections, updated subscription type names (SSRS, Overview, Search, Behavior Anomalies, Risks), fixed passive voice, improved table structure by splitting delivery options into separate rows, added generation time reference to Schedule row
  • Updated overview.md: aligned subscription type names and section order, removed redundant features from per-type sections, added Subscription to Overview Reports and Behavior Anomalies sections, improved SSRS section with full report type descriptions and acronym definition
  • Updated manage.md: added Configure Subscription Generation Time section with step-by-step procedure, default times (8:00 AM / 7:00 AM), and delivery variance note

Files changed

  • docs/auditor/10.8/admin/subscriptions/create.md
  • docs/auditor/10.8/admin/subscriptions/manage.md
  • docs/auditor/10.8/admin/subscriptions/overview.md

Generated with AI

Co-Authored-By: Claude claude-sonnet-4-6 noreply@anthropic.com
Co-Authored-By: Claude Code ai@netwrix.com

- Rewrote create.md: added overview and prerequisites sections, updated
  subscription type names (SSRS, Overview, Search, Behavior Anomalies,
  Risks), fixed passive voice, improved table structure by splitting
  delivery options into separate rows, added generation time reference
- Updated overview.md: aligned subscription type names and section order,
  removed redundant features from per-type sections, added Subscription
  to Overview Reports and Behavior Anomalies sections, improved SSRS
  section with full report type descriptions
- Updated manage.md: added Configure Subscription Generation Time section
  with procedure, default times, and delivery note

Generated with AI

Co-Authored-By: Claude claude-sonnet-4-6 <noreply@anthropic.com>
Co-Authored-By: Claude Code <ai@netwrix.com>
@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/auditor/10.8/admin/subscriptions/create.md

  • Clarity — Line 9: "SSRS" appears here without being spelled out on first use in this file. A reader landing directly on this page (from a sidebar link or search result) won't know what SSRS is. Suggested fix: Spell it out — "Subscriptions let you receive Netwrix Auditor overview and SQL Server Reporting Services (SSRS) reports, search results, …". After this, subsequent uses of "SSRS" in the file can stand alone.
  • Clarity — Line 37 (File format row): The description packs four subscription-to-format mappings into one run-on sentence with colons inside a table cell, which is hard to scan. The adjacent File delivery row (line 38) uses a bulleted pattern with - and bolded options; this row should match. Suggested fix: Rewrite as "Select the format for delivered files. Available formats depend on the subscription type: - Search or Behavior Anomalies — PDF or CSV. - SSRS — PDF, DOCX, CSV, or XLS. - Overview and Risks — not displayed; these subscription types always use PDF."
  • Completeness — Line 41 (Schedule row): The link "see [Review and Manage Subscriptions]" points at the whole page, but the relevant content is the new "Configure Subscription Generation Time" section. A reader following the link has to scan the destination page to find it. Suggested fix: Deep-link to the section — [Configure Subscription Generation Time](/docs/auditor/10.8/admin/subscriptions/manage.md#configure-subscription-generation-time).
  • Clarity — Line 43 (History row): "expand its details to understand and resolve the error" conflates two actions. Suggested fix: "expand its details to view the error, resolve it, then click Try again".
  • Structure — Line 41 (Schedule row): The default-generation-time fact ("SSRS subscriptions start generating at 8:00 AM and all other subscription types start generating at 7:00 AM") is duplicated verbatim in manage.md line 32. If the defaults ever change, both files must be updated in sync. Suggested fix: Keep the canonical statement on manage.md and shorten the Schedule row to point readers there — "By default, SSRS subscriptions and other subscription types generate at different times. For details and how to change them, see Configure Subscription Generation Time."

docs/auditor/10.8/admin/subscriptions/manage.md

  • Clarity — Line 24: "SSRS" is used here without being spelled out. This is the first occurrence of the acronym in this file. Suggested fix: "Generation times are configured separately for SQL Server Reporting Services (SSRS) and other subscription types."
  • Structure — Line 34: The **NOTE:** paragraph should be a Docusaurus admonition block per the project standard in docs/CLAUDE.md. Suggested fix:
    :::note
    Report generation starts at the selected time based on your local server time. Actual delivery time may vary depending on the report generation process queue, system performance, and the size of data included in the reports.
    :::
    
  • Completeness — Line 24: The new section explains how to change generation times but doesn't say who can do it. The role requirement (Global administrator or Global reviewer) is documented in create.md for creating subscriptions — readers may reasonably assume the same applies here, but it isn't stated. Suggested fix: Add one line confirming the role requirement, or link to the Role-Based Access and Delegation topic.

docs/auditor/10.8/admin/subscriptions/overview.md

  • Structure — Line 11: The sentence about adding elements to the Auditor Home screen is unrelated to subscriptions and sits awkwardly between the intro and the first subscription type. It breaks the reader's path from "what are subscriptions" to "what kinds of subscriptions exist." Suggested fix: Move this sentence to the "See Also" section at the bottom, or remove it (it duplicates guidance that already exists on the Navigation and Customize Home Screen topics).
  • Clarity — Line 37: "Advanced filters to make your results context match." is unclear — it's not obvious what "context match" means or what the filters do. Suggested fix: "Advanced filters to refine results by context — for example, by user, action, or object type." (Confirm the example values match the actual UI.)
  • Clarity — Line 3 (frontmatter description): The description lists "SSRS, Overview, Search, Behavior Anomalies, and Risks" but SSRS is not spelled out. This text appears in search engine results and page metadata where readers have no surrounding context. Suggested fix: "Overview of subscription types in Netwrix Auditor: Overview, SQL Server Reporting Services (SSRS), Search, Behavior Anomalies, and Risks."
  • Completeness — Line 23: The claim "a library of over 100 predefined report templates" is a specific quantitative statement. If the actual count has changed in 10.8 or could change in a future minor release, this number will go stale. Suggested fix: Confirm the count is accurate for 10.8, or soften to "a large library of predefined report templates" if the exact number is volatile.

Summary

10 editorial suggestions across 3 files. The most impactful are: spelling out SSRS on first use in create.md and manage.md, converting the **NOTE:** line in manage.md to a :::note admonition, and removing the duplicated default-generation-time sentence so the two files don't drift apart. 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
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

9 issues fixed, 0 skipped across 3 files

Category Fixes
Substitutions 1
TypeVsEnter (rewrite) 1
Dale: passive-voice 6
Dale: positional-references 1

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

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.

3 participants