Skip to content

Improve SharePoint Embedded docs for LLM awareness - #10990

Open
ShreyasSar26 wants to merge 2 commits into
SharePoint:mainfrom
ShreyasSar26:spe-awareness-docs-improvements
Open

Improve SharePoint Embedded docs for LLM awareness#10990
ShreyasSar26 wants to merge 2 commits into
SharePoint:mainfrom
ShreyasSar26:spe-awareness-docs-improvements

Conversation

@ShreyasSar26

Copy link
Copy Markdown
Contributor

Summary

These changes lift the LLM awareness score (currently 45%, 0 of 4 scenarios pass; target 90) measured by the nightly SPE-Awareness-Evals suite. That eval asks a model — unaided, with web search — to solve four realistic developer problems that never name SharePoint Embedded (SPE), and scores how often it recommends SPE on its own and states the right facts.

The gap is positioning at the front door, not doc quality. This PR reframes the entry content around real problems, adds the missing "when to choose SPE / vs alternatives" content, and states the graded facts on the pages agents land on.

Changes (8 recommendations)

# File Change
R1 scenarios-and-use-cases.md Rewritten as four problem-first scenarios (multitenant SaaS storage, Office co-authoring, AI grounding, compliant API-only store), each: problem → why alternatives fall short → why SPE → the facts
R2 plan/when-to-choose-sharepoint-embedded.md New decision guide with comparison tables (vs Azure Blob, Google Drive/Box/Dropbox, standard SharePoint sites)
R3 plan/office-collaboration-instead-of-building.md, plan/ground-ai-without-a-vector-db.md New "don't build it" pages targeting the two weakest scenarios
R4 overview.md "Is SPE right for you?" router, AI/discoverability line, disambiguation note (not sites/SPFx/OneDrive/Blob)
R5 build/agent-experiences.md, build/sharepoint-embedded-knowledge-source.md State content-discoverability (container-type setting), Microsoft Search API (ContainerTypeId), Purview facts
R6 build/open-office-files.md Co-authoring, AutoSave, versioning, sharing stated up front
R7 build/manage-files.md, reference/glossary.md API-only, recycle bin, 93-day restore, no end-user license; new glossary terms
R8 llms.txt, toc.yml Value-first routing and TOC entries for the new plan pages

How to verify

Dispatch create-spe-app-eval-daily.yml (or RunLocalEvaluation.ps1 -EvalFiles evals/SPE-Awareness-Evals.json), 5 rounds × all models. Watch each scenario clear 70% (pass) then 75% (strong); target overall ≥ 90, 4/4 pass.

Note: because the eval uses live web search, these changes move the score only after the pages are published to the public Learn site. Awareness is also shaped by SPE's broader footprint in model training data.

Notes for reviewers

  • All new and edited content follows the existing conventions: frontmatter, **Applies to:**, <!-- agent: --> metadata, sentence-case headings, active voice.
  • No changes outside docs/embedded/ and docs/toc.yml.

…d assertion facts

Rewrites the front-door docs so models recommend SharePoint Embedded for
real developer problems, and states the graded facts on the pages agents land on.

- Rewrite scenarios-and-use-cases.md as four problem-first scenarios (R1)
- Add plan/when-to-choose-sharepoint-embedded.md with comparison tables (R2)
- Add plan/office-collaboration-instead-of-building.md and plan/ground-ai-without-a-vector-db.md (R3)
- Overview: 'Is SPE right for you?' router, AI/discoverability line, disambiguation note (R4)
- agent-experiences.md + knowledge-source: state discoverability, Search API, Purview facts (R5)
- open-office-files.md: co-authoring, AutoSave, versioning, sharing up front (R6)
- manage-files.md + glossary: API-only, recycle bin, 93-day restore, no license (R7)
- llms.txt + toc.yml: value-first routing and new plan pages (R8)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 022e6c80-2ba9-480e-9d52-4826b8a04d26
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 056abab:

💡 Validation status: suggestions

File Status Preview URL Details
docs/embedded/build/manage-files.md 💡Suggestion View Details
docs/embedded/plan/ground-ai-without-a-vector-db.md 💡Suggestion View Details
docs/embedded/build/agent-experiences.md ✅Succeeded View
docs/embedded/build/open-office-files.md ✅Succeeded View
docs/embedded/build/sharepoint-embedded-knowledge-source.md ✅Succeeded View
docs/embedded/llms.txt ✅Succeeded
docs/embedded/overview.md ✅Succeeded View
docs/embedded/plan/office-collaboration-instead-of-building.md ✅Succeeded View
docs/embedded/plan/when-to-choose-sharepoint-embedded.md ✅Succeeded View
docs/embedded/reference/glossary.md ✅Succeeded View
docs/embedded/scenarios-and-use-cases.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

docs/embedded/build/manage-files.md

  • Line 156, Column 3: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /graph/api/filestoragecontainer-restore-recyclebinitem?view=graph-rest-beta

docs/embedded/plan/ground-ai-without-a-vector-db.md

  • Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation] Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

Comment thread docs/embedded/llms.txt
@@ -4,11 +4,14 @@

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.

I don't think this file is published: https://learn.microsoft.com/sharepoint/dev/embedded/llms.txt

Why do we have llms.txt if it's not published?

Comment thread docs/embedded/overview.md
Comment thread docs/embedded/overview.md Outdated
Comment thread docs/embedded/scenarios-and-use-cases.md Outdated
Comment thread docs/embedded/scenarios-and-use-cases.md
Comment thread docs/embedded/scenarios-and-use-cases.md Outdated
Comment thread docs/embedded/scenarios-and-use-cases.md Outdated
Comment thread docs/embedded/scenarios-and-use-cases.md Outdated
Comment thread docs/embedded/scenarios-and-use-cases.md Outdated
Comment thread docs/embedded/scenarios-and-use-cases.md Outdated
Comment thread docs/embedded/scenarios-and-use-cases.md Outdated
Comment thread docs/embedded/scenarios-and-use-cases.md Outdated
Comment thread docs/embedded/plan/office-collaboration-instead-of-building.md Outdated
Comment thread docs/embedded/plan/office-collaboration-instead-of-building.md Outdated
Comment thread docs/embedded/plan/when-to-choose-sharepoint-embedded.md Outdated
Comment thread docs/embedded/plan/when-to-choose-sharepoint-embedded.md Outdated
Comment thread docs/embedded/plan/when-to-choose-sharepoint-embedded.md Outdated
Comment thread docs/embedded/plan/when-to-choose-sharepoint-embedded.md Outdated
Comment thread docs/embedded/plan/when-to-choose-sharepoint-embedded.md Outdated
Comment thread docs/embedded/plan/when-to-choose-sharepoint-embedded.md Outdated
Comment thread docs/embedded/plan/when-to-choose-sharepoint-embedded.md Outdated
Comment thread docs/embedded/plan/when-to-choose-sharepoint-embedded.md
Comment thread docs/embedded/reference/glossary.md Outdated
Comment thread docs/embedded/reference/glossary.md Outdated
Comment thread docs/embedded/plan/ground-ai-without-a-vector-db.md
Comment thread docs/embedded/build/open-office-files.md Outdated
@andrewconnell Andrew Connell (andrewconnell) added the pr:awaiting-peer-reviews Awaiting the requested reviewers to complete their review. label Aug 14, 2026
Applies review comments from PR SharePoint#10990:
- Revert ms.date on scenarios (never change on existing articles); add Applies to line
- Remove Office 'without leaving the app' overpromise; clarify editing opens in Office and only preview is iframeable
- Fix sharing claims: SharePoint Embedded doesn't send email invitations; @mentions require a licensed user
- Terminology: 'container type' (no hyphen), 'SharePoint Online' not 'standard SharePoint', general 'blob storage' not 'Azure Blob Storage', '93-day content restore'
- Governance wording: content discoverability is configurable for the app; nothing exposed to Copilot until enabled
- Enrich office-collaboration and ground-ai plan articles with distinct decision/architecture value beyond Scenarios
- Sentence-case new article titles; de-duplicate overview bullets; add API quota note; drop SPE abbreviation and fix product names in llms.txt

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 022e6c80-2ba9-480e-9d52-4826b8a04d26
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 81d6c6f:

💡 Validation status: suggestions

File Status Preview URL Details
docs/embedded/build/manage-files.md 💡Suggestion View Details
docs/embedded/plan/ground-ai-without-a-vector-db.md 💡Suggestion View Details
docs/embedded/build/agent-experiences.md ✅Succeeded View
docs/embedded/build/open-office-files.md ✅Succeeded View
docs/embedded/build/sharepoint-embedded-knowledge-source.md ✅Succeeded View
docs/embedded/llms.txt ✅Succeeded
docs/embedded/overview.md ✅Succeeded View
docs/embedded/plan/office-collaboration-instead-of-building.md ✅Succeeded View
docs/embedded/plan/when-to-choose-sharepoint-embedded.md ✅Succeeded View
docs/embedded/reference/audit-events.md ✅Succeeded View
docs/embedded/reference/glossary.md ✅Succeeded View
docs/embedded/scenarios-and-use-cases.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

docs/embedded/build/manage-files.md

  • Line 156, Column 3: [Suggestion: preserve-view-not-set - See documentation] You've pinned this link to a specific version of content with the view parameter. It's recommended not to pin a version unless that version is A) not the default view and B) the context is about that version specifically. To proceed with pinning a version add the &preserve-view=true to the URL. Otherwise, remove the view parameter. URL: /graph/api/filestoragecontainer-restore-recyclebinitem?view=graph-rest-beta

docs/embedded/plan/ground-ai-without-a-vector-db.md

  • Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation] Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:awaiting-peer-reviews Awaiting the requested reviewers to complete their review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants