Skip to content

update documentation for power automate#814

Open
ivan-zamkovyi-nwx wants to merge 3 commits intodevfrom
feature/420908-power-automate
Open

update documentation for power automate#814
ivan-zamkovyi-nwx wants to merge 3 commits intodevfrom
feature/420908-power-automate

Conversation

@ivan-zamkovyi-nwx
Copy link
Copy Markdown

No description provided.

@github-actions
Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/directorymanager/11.1/admincenter/workflow/integrate.md

  • Structure — Line 34: The heading "Pre-steps before configuring connection to Power Automate" is redundant ("pre-steps before" means the same thing twice) and uses a gerund form inconsistent with the imperative-verb style of its sibling headings ("Connect an Identity Store to Power Automate", "Link an Identity Store Workflow to a Flow"). Because this section contains numbered procedure steps, it should use an imperative heading. Suggested fix: "Before you begin" or "Complete prerequisites for Power Automate"

  • Clarity — Line 36: "Check your certificate" is ambiguous — the reader doesn't know which certificate is meant (SSL/TLS certificate for the Directory Manager server, a client certificate, etc.). Suggested fix: Name the certificate explicitly, e.g., "Check the SSL certificate for the Directory Manager server and ensure it is valid."

  • Completeness — Line 36: Step 1 says to check the certificate but gives no guidance for when it is invalid — what should the reader do next? Suggested fix: Add a cross-reference to renewal or replacement instructions, or note that the certificate must be replaced before proceeding.

  • Clarity — Line 59: "the first part before dot" is missing the article "the" and is still vague. Suggested fix: "the segment before the first period (for example, myorg in myorg.crm.dynamics.com)" — or provide a concrete example inline.

  • Clarity — Line 100: "In the dialog box click Authorize with Power Automate button." is missing a comma after "dialog box," and appending "button" after a bold UI label is inconsistent with how other steps in this doc are written (e.g., step 5 says "click Register Client" without "button"). Suggested fix: "In the Power Automate Settings dialog box, click Authorize with Power Automate."

  • Clarity — Lines 100–102: "A pop-up will open —" mixes future tense with the present-tense procedural style used throughout the document, and uses an em dash to join two separate actions. Suggested fix: "A pop-up opens. Sign in with your corporate account and complete MFA. The pop-up closes automatically after a successful login."

  • Clarity — Line 111: Oxford comma missing in a three-part list. Suggested fix: "Launch Power Automate, choose your environment, and navigate to My Flows."

  • Clarity — Line 117: There is a stray, unmatched double-quote mark inside the bold span: **Who can trigger the flow"**. Suggested fix: Remove the stray quote — **Who can trigger the flow**.

  • Completeness — Line 117: Step 8.3 says to "set up Who can trigger the flow" but does not tell the reader what value to choose. Suggested fix: Specify the required setting, for example "set Who can trigger the flow to Anyone" (or whichever value is correct).

  • Clarity — Line 118: "set up new connection field" is missing the article "a." Suggested fix: "set up a new connection field."

  • Completeness — Line 118: Step 8.4 says to "set up a new connection field" without explaining what credentials or settings to provide. Suggested fix: State what the reader should enter — for example, whether to sign in with a Microsoft account, select an existing connection, or enter specific credentials.

  • Clarity — Line 119: "Navigate back to Edit window" is missing the article "the." Suggested fix: "Navigate back to the Edit window."

  • Clarity — Line 124: "HTTP POST URL" does not match the label used in sub-step 8.5, where the reader was told to copy the "HTTP URL." Inconsistent naming across steps creates confusion about whether these refer to the same URL. Suggested fix: Use the same label in both places — if the field is labeled "HTTP URL" in Power Automate, use that name here too.

  • Clarity — Line 124: "Then close dialog box." is missing the article "the" and reads as an afterthought appended to a step. One action per step is the standard pattern throughout this document. Suggested fix: Make it its own step — "Close the Power Automate Settings dialog box." — or at minimum write "Then close the Power Automate Settings dialog box."

Summary

14 editorial suggestions across 1 file. 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

8 issues fixed, 3 skipped across 1 files

Category Fixes
Contractions 2
Substitutions 1
Dale: passive-voice 4
Dale: wordiness 1
Skipped (needs manual review) Reason

| docs/directorymanager/11.1/admincenter/workflow/integrate.md:28 — Dale: passive-voice | actor is ambiguous — 'is approved' could be a human approver or system; fixing risks changing meaning |
| docs/directorymanager/11.1/admincenter/workflow/integrate.md:37 — Dale: passive-voice | 'is deployed' describes a required infrastructure state in a pre-step; rewriting to active voice would require specifying an actor that may not be the reader |
| docs/directorymanager/11.1/admincenter/workflow/integrate.md:65 — Dale: passive-voice | participial 'assigned to' in a field description list; fix would produce awkward phrasing without clear improvement |

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.

2 participants