Skip to content

[No QA] Update QBD help article for reusing existing connections - #87438

Merged
stephanieelliott merged 2 commits into
mainfrom
melvin/helpsite-qbd-reuse-existing-connection
Apr 21, 2026
Merged

stephanieelliott merged 2 commits into
mainfrom
melvin/helpsite-qbd-reuse-existing-connection

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Summary

  • Documents the new ability to reuse an existing QuickBooks Desktop connection across workspaces (introduced in Reuse existing QBD connection across workspaces #86909)
  • Adds a new "How to reuse an existing QuickBooks Desktop connection" section with step-by-step instructions
  • Adds an FAQ entry about reusing connections
  • Updates section headings from generic "Step N" format to task-based headings per HelpDot authoring guidelines

Test plan

Adds documentation for the new ability to reuse an existing QuickBooks
Desktop connection across workspaces, introduced in PR #86909. Also
updates section headings to follow HelpDot authoring guidelines.

Co-authored-by: Lucien Akchoté <lakchote@users.noreply.github.com>
@github-actions

github-actions Bot commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR improves the QuickBooks Desktop help article by adding documentation for reusing existing connections across workspaces and restructuring headings from the forbidden # Step N pattern to task-based ## How to... headings. The new content is clear, well-structured, and follows most governance conventions. A few metadata and structural gaps remain.

Scores Summary

  • Readability: 9/10 - The new steps are clear, sequential, and action-oriented. The reuse section is concise with a helpful closing sentence directing users to the "create new connection" flow. Scannability is strong.
  • AI Readiness: 7/10 - The heading restructuring to ## How to... is a significant improvement for retrieval. However, the required internalScope field is missing from YAML metadata, and the article still lacks an explicit # QuickBooks Desktop title heading (currently there is no # article title at all -- only # FAQ).
  • Style Compliance: 9/10 - UI element references are properly bolded, navigation phrasing matches the approved pattern, and the new FAQ entry uses a question-based heading. No prohibited language detected.

Key Findings

  • Positive: The conversion of # Step 1/2/3 headings (explicitly forbidden by governance as generic headings) to task-based ## How to... headings is exactly the right fix. All three new ## headings include the feature name "QuickBooks Desktop" and start with "How to", satisfying AI retrieval optimization rules.
  • Positive: The new "reuse existing connection" section follows the established step pattern, with proper bolding of UI elements (Workspaces, More features, Accounting, Set up) and correct navigation phrasing.
  • Positive: The new FAQ entry ("Can I reuse an existing QuickBooks Desktop connection on a new workspace?") is well-written and uses a question-based heading as required.
  • Issue: The internalScope field is missing from the YAML frontmatter. Per HELP_AUTHORING_GUIDELINES.md Section 3, this is mandatory. It should specify the target audience and workflow scope (e.g., internalScope: Audience is Workspace Admins. Covers connecting QuickBooks Desktop to Expensify and reusing existing connections, does not cover QuickBooks Desktop export or sync configuration.).
  • Issue: The article has no # title heading. The governance rules require exactly one # heading as the article title (plus the optional # FAQ). While this was a pre-existing gap, the PR is restructuring headings and would be the ideal time to add # QuickBooks Desktop after the frontmatter.
  • Minor: The keyword addition ("reuse existing connection") is helpful for search. Consider also adding "share connection" or "copy connection" if those are common search terms.

Recommendations

  1. Add internalScope to YAML frontmatter -- This is a required metadata field per governance. Suggested value: internalScope: Audience is Workspace Admins. Covers connecting QuickBooks Desktop to Expensify and reusing existing connections across workspaces, does not cover QuickBooks Desktop export or sync configuration.
  2. Add the # QuickBooks Desktop title heading -- Place it immediately after the frontmatter, before the introductory paragraph. This satisfies the "exactly one # heading" structural requirement.
  3. Both of the above are governance requirements. The content quality of the new sections is strong and ready to ship once these metadata/structural items are addressed.

Files Reviewed

  • docs/articles/new-expensify/connections/quickbooks-desktop/Connect-to-QuickBooks-Desktop.md -- New "reuse existing connection" section added, headings restructured from # Step N to ## How to..., new FAQ entry added. Content quality is high; needs internalScope metadata and # title heading.

@stephanieelliott
stephanieelliott requested a review from a team April 13, 2026 22:20
@melvin-bot

melvin-bot Bot commented Apr 13, 2026 •

Copy link
Copy Markdown

Concierge reviewer checklist:

  • I have verified the accuracy of the article
    • The article is within a hub that makes sense, and the navigation is correct
    • All processes, screenshots, and examples align with current product behavior.
    • All links within the doc have been verified for correct destination and functionality.
  • I have verified the readability of the article
    • The article's language is clear, concise, and free of jargon.
    • The grammar, spelling, and punctuation are correct.
    • The article contains at least one image, or that an image is not necessary
  • I have verified the formatting of the article
    • The article has consistent formatting (headings, bullet points, etc.) with other HelpDot articles and that aligns with the HelpDot formatting standards.
    • The article has proper text spacing and breaks for readability.
  • I have verified the article has the appropriate tone and style
    • The article's tone is professional, friendly, and suitable for the target audience.
    • The article's tone, terminology, and voice are consistent throughout.
  • I have verified the overall quality of the article
    • The article is not missing any information, nor does it contain redundant information.
    • The article fully addresses user needs.
  • I have verified that all requested improvements have been addressed

For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member?

cc @johncschuster

@melvin-bot
melvin-bot Bot requested review from johncschuster and removed request for a team April 13, 2026 22:20
@melvin-bot

melvin-bot Bot commented Apr 13, 2026

Copy link
Copy Markdown

@johncschuster Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@github-actions github-actions Bot changed the title Update QBD help article for reusing existing connections [No QA] Update QBD help article for reusing existing connections Apr 13, 2026
@OSBotify

Copy link
Copy Markdown
Contributor

A preview of your ExpensifyHelp changes have been deployed to https://8ab05465.helpdot.pages.dev ⚡️

Updated articles:

@stephanieelliott
stephanieelliott merged commit 607f86c into main Apr 21, 2026
15 checks passed
@stephanieelliott
stephanieelliott deleted the melvin/helpsite-qbd-reuse-existing-connection branch April 21, 2026 00:39
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/stephanieelliott in version: 9.3.61-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.3.61-4 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

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.

5 participants