feat(agents): add docs-writer agent for documentation authoring#199
Merged
ayeshurun merged 1 commit intomicrosoft:mainfrom Mar 22, 2026
Merged
Conversation
ayeshurun
previously approved these changes
Mar 22, 2026
ayeshurun
reviewed
Mar 22, 2026
Add a specialized Copilot agent for writing and reviewing Fabric CLI documentation. The agent enforces Microsoft Style Guide compliance, Fabric CLI terminology, forbidden terms, and MkDocs conventions. Covers: documentation pages, command help text, error messages, and release notes.
jeremydhoover-blip
force-pushed
the
agents/docs-writer
branch
from
3dd6a68 to
5d2aede
Compare
ayeshurun
approved these changes
Mar 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of new changes
Summary:
Add
.github/agents/docs-writer.md— a Copilot agent that owns all user-facing text quality for the Fabric CLI.Context
The repo has
copilot-instructions.mdfor development patterns and.github/instructions/for command and test guidance, but nothing that governs documentation quality at authoring time. Contributors writing docs, help text, or error messages currently have no guardrails for style, terminology, or structure. This agent fills that gap so documentation output is consistent from the first draft.What the agent covers:
10 hard constraints — security (no real credentials, no internal URLs), accuracy (no fabricated references or speculative docs), and preservation of existing content
Fabric CLI writing conventions —
fabbinary name, path type suffixes (Name.Type), sign-in vs. login distinctionMicrosoft Style Guide rules — tone and voice, grammar (active voice, present tense, imperative mood), word choice, headings (sentence case, hierarchy), lists, emphasis, punctuation, numbers, acronyms, procedures, code examples, CLI conventions, links, inclusive language, and responsive content guidelines
Forbidden terms table — 40+ banned terms with replacements across input, tone, verbose, jargon, aggressive, inclusive, accessibility, Latin, ambiguous, placeholder, and Fabric CLI categories
Writing process — 5-step workflow: classify request, match existing patterns, write and validate (with a concrete checklist), check cross-reference impact (new pages, updated pages, new item types), and deliver with terminology notes
Fallback templates — command reference page and changie release note entry
Command help text rules — command descriptions, argument/flag help strings, and
--helpexample conventionsError message rules — structure patterns, writing standards, and guidance on when to create new error files
Fabric terminology tables — correct usage for CLI/general, CI/CD, data engineering, data warehouse/SQL, Power BI, and security terms, plus a preferred-verb table for CLI actions
Documentation review checklist — structured review output with must-fix/should-fix/consider categories
Dependencies: None. A separate open PR adds another agent file to the same
.github/agents/directory.