Skip to content

Update QBD help article for reusing existing connections#87438

Open
MelvinBot wants to merge 1 commit intomainfrom
melvin/helpsite-qbd-reuse-existing-connection
Open

Update QBD help article for reusing existing connections#87438
MelvinBot wants to merge 1 commit intomainfrom
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>
title: QuickBooks Desktop
description: Easily connect Expensify to QuickBooks Desktop for streamlined expense management and accounting.
keywords: [New Expensify, QuickBooks Desktop, Web Connector, accounting integration, expense management]
keywords: [New Expensify, QuickBooks Desktop, Web Connector, accounting integration, expense management, reuse existing connection]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing required metadata: The YAML frontmatter is missing the internalScope field, which is mandatory per HELP_AUTHORING_GUIDELINES.md Section 3 and TEMPLATE.md.

Add something like:

internalScope: Audience is Workspace Admins. Covers connecting QuickBooks Desktop to Expensify and reusing existing connections, does not cover configuring export or coding settings.

---

# Step 1: Start the Setup in Expensify
## How to reuse an existing QuickBooks Desktop connection
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Structure violation: The article is missing its single required # heading (article title). Per HELP_AUTHORING_GUIDELINES.md Section 4, every article must have exactly one # heading as the article title. The old # Step 1/2/3 headings were correctly converted to ##, but a # title heading needs to be added above the intro paragraph.

Add a title heading like:

# How to connect QuickBooks Desktop to Expensify

This should appear right after the YAML frontmatter closing ---, before the introductory text.

---

# Step 2: Install and Launch the Web Connector
## How to install and launch the Web Connector
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI readiness: This heading should include the full feature name "QuickBooks Desktop" for searchability and retrieval optimization, consistent with the other changed headings in this PR.

Suggested fix:

## How to install and launch the QuickBooks Desktop Web Connector

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 9, 2026

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.

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