Skip to content

Add FSAA DC schema documentation for Access Analyzer 12.0#931

Open
tay-caliguiri wants to merge 4 commits into
devfrom
naa-12.0-fsaa-schema-docs
Open

Add FSAA DC schema documentation for Access Analyzer 12.0#931
tay-caliguiri wants to merge 4 commits into
devfrom
naa-12.0-fsaa-schema-docs

Conversation

@tay-caliguiri
Copy link
Copy Markdown
Contributor

Adds full schema documentation set for the File System Access Analyzer Data Collector under admin/schema/fsaadc/: ERD, core tables, views, enumeration, functions, index reference, and foreign key reference pages, plus category.json sidebar files. Updates schema overview page to include the FSAA DC section below SQL DC.

Adds full schema documentation set for the File System Access Analyzer
Data Collector under admin/schema/fsaadc/: ERD, core tables, views,
enumeration, functions, index reference, and foreign key reference pages,
plus _category_.json sidebar files. Updates schema overview page to
include the FSAA DC section below SQL DC.

Generated with AI

Co-Authored-By: Claude Code <ai@netwrix.com>
@tay-caliguiri tay-caliguiri requested a review from a team as a code owner May 14, 2026 22:28
@github-actions
Copy link
Copy Markdown
Contributor

Auto-Fix Summary

17 issues fixed, 5 skipped across 9 files

Category Fixes
Contractions 6
Plurals 1
FirstPersonPlural (rewrite) 1
OxfordComma (rewrite) 1
WeakLinkText (rewrite) 1
Dale: idioms 2
Dale: positional-references 5
Skipped (needs manual review) Reason

| docs/accessanalyzer/12.0/admin/schema/fsaadc/erd/overview.md:122 — Dale: idioms | 'firehose' is a widely understood technical metaphor; rewording would risk losing the high-volume-stream connotation |
| docs/accessanalyzer/12.0/admin/schema/fsaadc/coretables/overview.md:188 — Dale: idioms | 'structural backbone' is a common technical metaphor; rewording risks changing emphasis |
| docs/accessanalyzer/12.0/admin/schema/fsaadc/coretables/overview.md:611 — Dale: idioms | 'firehose' is a widely understood technical metaphor for high-volume event streams |
| docs/accessanalyzer/12.0/admin/schema/fsaadc/coretables/overview.md:0 — Dale: passive-voice | Many passive-voice constructions in schema reference content (e.g. 'is populated by', 'are stored', 'is partitioned by') are the natural register for describing what tables contain; flipping them broadly could distort meaning or feel forced. Skipped to avoid changing author intent. |
| docs/accessanalyzer/12.0/admin/schema/fsaadc/enumeration/overview.md:3 — Dale: undefined-acronyms | FSAA is used in body prose but the page is a deep-reference sub-page reached from a parent overview that defines it; adding a parenthetical definition on every sub-page would be redundant given the strong subject context |

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

@tay-caliguiri
Copy link
Copy Markdown
Contributor Author

@claude fix all issues

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 14, 2026

Fix complete:

The doc-pr editorial review hadn't run yet, so I interpreted "fix all issues" as addressing the 5 items the auto-fix workflow skipped for manual review.

  • Fix structural backbone metaphor in coretables/overview.md
  • Fix firehose metaphors in erd/overview.md and coretables/overview.md
  • Define FSAA on first use in enumeration/overview.md
  • Commit and push

Summary:

  • coretables/overview.md:188 — "structural backbone" → "central resource inventory"
  • coretables/overview.md:611 — "activity-event firehose" → "high-volume activity-event stream"
  • erd/overview.md:122 — "audit-event firehose" → "high-volume audit-event stream"
  • enumeration/overview.md:3 — "FSAA DC schema" → "File System Access Analyzer (FSAA) DC schema"

Skipped intentionally:

  • Passive voice in schema reference content (coretables/overview.md:0). Constructions like "is populated by", "is partitioned by", and "are stored" are the natural register for describing what tables contain; rewriting them broadly would distort meaning or feel forced. If you'd like specific passages flipped to active voice, point me at them and I'll rewrite.

If the doc-pr editorial review surfaces additional issues once it completes, tag @claude again with what you'd like fixed.

Replace 'firehose' and 'structural backbone' metaphors with literal
descriptions per Netwrix style (no idioms or metaphors). Define FSAA
on first use in the enumeration page.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

This PR adds a comprehensive File System Access Analyzer Data Collector (FSAA DC) schema reference: a top-level overview page plus six sub-pages covering tables, views, enumerations, ERDs, functions, indexes, and foreign keys. Most of the content is reference-style (tables of columns, FK constraints, indexes), which the four core qualities apply to but tend to forgive dense, structured material.

docs/accessanalyzer/12.0/admin/schema/fsaadc/overview.md

  • Structure — Lines 5, 22, 51, 87, 92, 99: The page skips from # (H1) directly to ### (H3) for the six top-level section headings (Table Relationship Diagrams, Core Data Collection Tables, Views, Enumeration & Lookup Values, Functions & Stored Procedures, Index Reference, Foreign Key Reference). docs/CLAUDE.md says never skip heading levels. The parent page docs/accessanalyzer/12.0/admin/schema/overview.md already uses ## with bullet links for sibling collectors (SQL DC, and the new FSAA DC section it adds on lines 2465+ of the diff), so this index page is also inconsistent with the established sibling pattern. Suggested fix: change each ### to ## on this page; alternatively flatten to a single ## heading with a bulleted link list to match the sqldc style.

docs/accessanalyzer/12.0/admin/schema/fsaadc/coretables/overview.md

  • Clarity — [idiom] Line 611 (### SA_FSAC_ActivityEvents description): "The activity-event firehose. One row per audited file-system operation captured by an FSAC agent." "Firehose" is a figurative term that may not translate well for newer readers. Suggested fix: "The activity-event log — one row per audited file-system operation captured by an FSAC agent."
  • Completeness — Line 449 (SA_FSAA_ScanHistory.ConsoleHost row description): "NAA console that initiated the scan." NAA is used here for the first and only time in this file without being spelled out. Per the style guide, spell out acronyms on first use. Suggested fix: "Netwrix Access Analyzer (NAA) console that initiated the scan." Or use the unabbreviated form (the same column is described as "NAA console" once and "Console host that initiated the scan" in the SA_FSAA_Hosts.SAConsole row on line 27 — pick one phrasing and apply it consistently).

docs/accessanalyzer/12.0/admin/schema/fsaadc/erd/overview.md

  • Clarity — [idiom] Line 122 (## Activity Collection (SA_FSAC_*)): "SA_FSAC_ActivityEvents is the audit-event firehose; each row is one observed file-system operation." Same "firehose" idiom as in coretables — and the parallel phrasing means both should be updated together to keep the description consistent. Suggested fix: "SA_FSAC_ActivityEvents is the audit-event log; each row is one observed file-system operation."

docs/accessanalyzer/12.0/admin/schema/fsaadc/enumeration/overview.md

  • No issues found.

docs/accessanalyzer/12.0/admin/schema/fsaadc/fkreference/overview.md

  • No issues found.

docs/accessanalyzer/12.0/admin/schema/fsaadc/functions/overview.md

  • No issues found.

docs/accessanalyzer/12.0/admin/schema/fsaadc/indexreference/overview.md

  • No issues found.

docs/accessanalyzer/12.0/admin/schema/fsaadc/views/overview.md

  • No issues found.

docs/accessanalyzer/12.0/admin/schema/overview.md

  • No issues found. The added FSAA DC section matches the existing SQL DC section in structure, voice, and depth.

Summary

4 editorial suggestions across 3 files (one structural heading-level issue, two parallel idiom flags, and one acronym definition). The remaining six files are clean. 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.

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