@@ -21,6 +21,11 @@ Gather details about the blog to be created:
2121 - What is the feature or topic of the blog?
2222 - Does the user have specifications, related documentation, or other content that can be used for reference?
2323 - If there are no specifications, can the user describe the feature and the necessary elements for the blog content?
24+ - Are there screenshots or images available? If so, where are they located?
25+
26+ ** Target lengths:**
27+ - Blog blurb: ~ 110-150 words
28+ - Standalone blog: ~ 900-1000 words
2429
2530Update the list of tasks to reflect the completion of Phase 1.
2631 </workflow >
@@ -46,24 +51,37 @@ Gather comprehensive context about the requested task and return findings to the
4651
4752<workflow >
4853
49- Create an outline specific to the provided subject. Do not proceed until the user has approved.
54+ Create a detailed outline specific to the provided subject. Present the plan to the user and do not proceed until the user has explicitly approved.
55+
56+ If the user requests changes, update the outline and seek approval again.
5057
51- Take into account the following general structures:
58+ Take into account the following structures:
5259
53- ** Blog blurb**
54- - What is the feature and why should I care
55- - Screenshots (if applicable)
56- - Link to learn more in documentation. The link should be absolute (e.g., https://learn.microsoft.com/azure/ ...)
57- - Do not encourage users to try the feature
58- - The audience is people looking to see what's new in the product
59-
60- ** Standalone blog**
61- - An expanded version of the blog blurb
62- - Include scenarios for when to use this feature and how it can be used in conjunction with other parts of the product
63- - Include a next steps section for users to get started, linking to documentation
64- - Do not encourage users to try the feature
65- - The audience is users who are new to this area of the product
66- - Call to action.
60+ ** Blog blurb structure (~ 110-150 words)**
61+ - Opening: What is the feature and its primary benefit
62+ - Key capabilities: 2-3 main features or improvements
63+ - Visual element: Screenshot or diagram (if applicable)
64+ - Documentation link: Absolute URL to learn more without language encoding (e.g., https://learn.microsoft.com/fabric/ ...)
65+ - Tone: Concise, informative, punchy
66+ - Audience: Users scanning for what's new in the product
67+ - Avoid: Calls to "try it now" or "get started today" - use neutral language like "Learn more" or "See documentation"
68+
69+ ** Standalone blog structure (~ 900-1000 words)**
70+ - Introduction (1-2 paragraphs): What is the feature and why it matters
71+ - Problem/scenario (2-3 paragraphs): What challenges does this address?
72+ - How it works (2-4 paragraphs): Explain the feature's functionality
73+ - Use cases (2-3 scenarios): Specific examples of when to use this feature
74+ - Multi-tenant environments
75+ - Department-based access
76+ - Role-based permissions
77+ - Compliance requirements
78+ - Integration with other features
79+ - Getting started: Links to documentation with context (not just "click here")
80+ - Related features: How this works with other product capabilities
81+ - Conclusion: Summary with resource links
82+ - Tone: Explanatory, detailed, educational
83+ - Audience: Users new to this area of the product
84+ - Avoid: Marketing hype or pressure to adopt - focus on education and enablement
6785
6886Update the list of tasks to reflect the completion of Phase 3.
6987</workflow >
@@ -73,42 +91,99 @@ Update the list of tasks to reflect the completion of Phase 3.
7391<workflow >
7492Based on the approved outline, the user's requirements, and research findings, create the requested blog content.
7593
94+ ## HTML Structure Guidelines
95+ - Use semantic HTML tags: ` <h2> ` , ` <h3> ` , ` <p> ` , ` <ul> ` , ` <ol> ` , ` <a> ` , ` <strong> ` , ` <code> `
96+ - Headings: Use ` <h2> ` for main sections, ` <h3> ` for subsections
97+ - Links: Use descriptive link text, not "click here" or "learn more"
98+ - ✅ ` <a href="https://learn.microsoft.com/...">Learn about row-level security policies</a> `
99+ - ❌ ` <a href="https://learn.microsoft.com/...">Click here</a> `
100+ - Lists: Use ` <ul> ` for unordered, ` <ol> ` for sequential steps
101+ - Code: Use ` <code> ` for inline code, consider ` <pre><code> ` for blocks
102+ - Images (if applicable): Include descriptive alt text
103+ - ` <img src="image-url.png" alt="Screenshot showing the access control configuration panel"> `
104+
105+ ## Link Requirements
106+ - All documentation links must be absolute URLs starting with https://learn.microsoft.com/
107+ - Verify that linked documentation exists in the repository
108+ - Use descriptive anchor text that explains what the user will find
109+
110+ After completing the content, present it to the user for review before proceeding to Phase 5.
111+
76112 Update the list of tasks to reflect the completion of Phase 4.
77113</workflow >
78114
79115# Phase 5: Enforce Style Guide
80116
81117<workflow >
82118
83- Review the provided content and improve it to align with Microsoft's writing style guidelines. Key guidelines to enforce include:
119+ Review the provided content and improve it to align with Microsoft's writing style guidelines.
120+
121+ Mention what changes you made in the chat response.
122+
123+ ## Output Format
124+ - The returned format is HTML only. Do not include markdown or other formats.
125+ - Present the HTML in a code block for easy copying
126+ - Ensure proper HTML formatting with indentation
84127
85- - The returned format is HTML only. Do not include any other format or markdown.
128+ ## Content Guidelines
86129 - Follow Microsoft documentation style guidelines: https://learn.microsoft.com/en-us/style-guide/welcome/
87- - ** Use plain, inclusive language**
130+ - ** Use plain, inclusive language** - Avoid gender-specific terms, use neutral examples
88131 - ** Use present tense** - "This feature lets you..." not "This feature will let you..."
89- - ** Be conversational but professional** - Use contractions (it's, you're, don't) for friendliness.
90- - ** Avoid marketing language** - No hype, flowery language, or product advertisements. Language should be neutral, functional and instructional. Example of words that should be avoided: "cutting-edge", "state-of-the-art", "industry-leading", "unparalleled", "revolutionary", "strealine", ...
91- - ** Avoid idioms and clichés** - Write for a global audience with plain language.
132+ - ** Be conversational but professional** - Use contractions (it's, you're, don't) for friendliness
133+ - ** Avoid marketing language** - No hype, flowery language, or product advertisements. Language should be neutral, functional and instructional.
134+
135+ ** Avoid these marketing words:**
136+ - "cutting-edge", "state-of-the-art", "industry-leading"
137+ - "unparalleled", "revolutionary", "game-changing"
138+ - "streamline", "leverage", "robust"
139+ - "powerful", "innovative", "seamless"
140+
141+ ** Examples:**
142+ - ❌ "This revolutionary feature lets you leverage cutting-edge technology"
143+ - ✅ "This feature lets you control access with role-based permissions"
144+
145+ - ** Avoid idioms and clichés** - Write for a global audience with plain language
146+ - ** Avoid pressure tactics** - Don't use "Try it now!", "Don't miss out!", "Get started today!"
147+ - ✅ Acceptable: "Learn more", "See documentation", "Explore the feature"
92148
93149 Update the list of tasks to reflect the completion of Phase 5.
94150 </workflow >
95151
96- # Phase 6: Review and Finalize
152+ # Phase 6: Validation and Finalization
97153
98154<workflow >
99155
100-
101- Review the entire document for clarity, coherence, and completeness. Ensure that:
102- - The returned format is HTML only. Do not include any other format or markdown.
103- - The content meets the user's requirements
104- - The information is accurate and up-to-date
105- - The document flows logically and is easy to read
106- - Content structure needs reorganization for better scanning
107-
108- Ask for user feedback and make any necessary revisions based on their input.
109-
110- - Content structure needs reorganization for better scanning
111- - Acronyms are overused or undefined
156+ Perform final validation checks before delivering the content:
157+
158+ ## Content Validation
159+ - ** Word count** : Verify length matches target (blurb: 110-150 words, standalone: 900-1000 words)
160+ - ** Accuracy** : Ensure all technical information is correct and up-to-date
161+ - ** Completeness** : All sections from approved outline are included
162+ - ** Flow** : Content reads logically and transitions smoothly between sections
163+ - ** Clarity** : Technical concepts are explained clearly for the target audience
164+
165+ ## Technical Validation
166+ - ** HTML syntax** : Validate that HTML is properly formed and tags are closed
167+ - ** Links** : Verify all documentation links are absolute URLs (https://learn.microsoft.com/ ...)
168+ - ** Link text** : Ensure links use descriptive anchor text, not generic phrases
169+ - ** Images** : Check that alt text is meaningful and descriptive (if images included)
170+ - ** Acronyms** : First use is spelled out, or acronym is widely known
171+
172+ ## Style Validation
173+ - ** Tone** : Appropriate for blog type (punchy for blurbs, educational for standalone)
174+ - ** Marketing language** : Scan for and remove any hype words that were missed
175+ - ** Present tense** : Verify consistent use of present tense
176+ - ** Pressure tactics** : Ensure no calls to "try it now" or similar language
177+
178+ ## Final Delivery
179+ - Present the final HTML content in a code block
180+ - Provide a brief summary of the content
181+ - Ask if the user would like any revisions
182+
183+ If revisions are requested:
184+ - Clarify what needs to be changed
185+ - Make the updates
186+ - Re-validate before presenting again
112187
113188 Update the list of tasks to reflect the completion of Phase 6.
114189</workflow >
0 commit comments