Skip to content

Commit 8a0b445

Browse files
committed
Upd prompt
Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
1 parent bec6c3d commit 8a0b445

File tree

1 file changed

+47
-32
lines changed

1 file changed

+47
-32
lines changed

scripts/blog-prompt.md

Lines changed: 47 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,55 @@
1-
Write a technical blog post announcing Radius {RELEASE_NAME} for developers and platform engineers.
1+
Write a technical blog post announcing Radius {RELEASE_NAME} for developers and platform engineers. Follow the Radius blog style guide exactly.
22

3-
Release notes:
3+
Release notes (YOUR ONLY SOURCE OF TRUTH):
44
{RELEASE_NOTES}
5+
6+
Style reference from previous posts:
57
{BLOG_CONTEXT}
68

7-
Context for the blog post generation:
8-
- Radius documentation: https://docs.radapp.io/
9-
- Radius GitHub repository: https://github.com/radius-project/radius
10-
- Radius blog repository: https://github.com/radius-project/blog
11-
- Style and formatting guidelines: https://github.com/radius-project/blog/blob/re/ab/radblog/guide/contribution-guide.md
12-
13-
Requirements:
14-
- Target audience: Application developers, platform engineers, DevOps practitioners
15-
- Focus on concrete functionality and implementation details with technical reasoning
16-
- Technical depth over marketing fluff
17-
- Avoid marketing language like "we're excited", "with open arms", "happy building"
18-
- CRITICAL: Only include information that is explicitly stated in the release notes - do not expand, infer, or add details
19-
- Only include code examples, configuration snippets, or commands that are explicitly mentioned in the release notes
20-
- Only include information and code samples that you can verify from the Radius code or documentation
21-
- Do NOT make up code examples following common industry patterns from similar projects if they are not specifically mentioned in the release notes or docs
22-
- Do NOT make up documentation links - only use links that are specifically mentioned in the release notes or that you can verify from the Radius documentation
23-
- When including code snippets, ensure they are spaced and formatted correctly for markdown
24-
- If you cannot verify information from the release notes, do not include it
25-
- 800-1000 words of substantive technical content
9+
CRITICAL CONSTRAINTS - FOLLOW EXACTLY:
10+
- ONLY use information explicitly stated in the release notes above
11+
- Do NOT add any information not found in the release notes
12+
- Do NOT make up features, examples, or documentation links
13+
- Do NOT use marketing language like "we're excited", "introducing", "significant update"
14+
- Do NOT add introductory phrases like "Today we're announcing" or "We're pleased to"
15+
- Do NOT add horizontal rules (---) between sections
16+
- Do NOT speculate about future features or capabilities
17+
- ONLY include code examples that are explicitly shown in the release notes
18+
- ONLY include links that are explicitly mentioned in the release notes
19+
20+
WRITING STYLE (from Radius style guide):
21+
- Conversational and friendly without being frivolous
22+
- User-focused: Write in second person ("you") not first person ("we")
23+
- Clear and concise: Simple, direct language
24+
- Active voice and present tense
2625
- Professional, matter-of-fact tone
27-
- Avoid repetitive summaries or conclusions that restate what was already covered
28-
- Follow the style and formatting guidelines in the context links above
29-
30-
Structure:
31-
- Start immediately with introductory content - Do not include a title or heading since the Hugo front matter already provides the title
32-
- Direct introduction stating what's new in this release and a link to the release
33-
- Key Features as the main sections, with subheadings for each feature if applicable
34-
- Technical summary of key features with implementation details and code examples demonstrating usage within the key features.
35-
- Add breaking changes within the feature summary if applicable
36-
- DO NOT create a separate section for breaking changes.
37-
- Conclude with this standard "Learn more and Get Involved" section:
26+
- Technical depth over marketing content
27+
- Evidence-based: All claims supported by release notes only
28+
29+
CONTENT REQUIREMENTS:
30+
- Target audience: Application developers, platform engineers, DevOps practitioners
31+
- 800-1000 words of substantive technical content
32+
- Focus on concrete functionality and implementation details
33+
- Include technical reasoning when provided in release notes
34+
- Proper markdown formatting for code snippets
35+
36+
STRUCTURE REQUIREMENTS:
37+
- Start immediately with content - NO title, NO heading, NO introductory phrases
38+
- Begin directly with what's new in this release
39+
- Use ## headings for main features (not # headings)
40+
- Include breaking changes within relevant feature sections, not separately
41+
- Use clean markdown formatting without horizontal rules
42+
- End with the exact "Learn more and Get Involved" section below
43+
44+
EXAMPLES OF WHAT NOT TO DO:
45+
- "Today, we're introducing Radius v0.50.0..."
46+
- "We're pleased to announce..."
47+
- "# Announcing Radius v0.50.0"
48+
- "---" (horizontal rules between sections)
49+
- Adding features not mentioned in release notes
50+
- Making up code examples or documentation links
51+
52+
REQUIRED CLOSING SECTION (copy exactly):
3853

3954
## Learn more and Get Involved
4055

0 commit comments

Comments
 (0)