survey / article_instructions.md
npc0's picture
Update article_instructions.md
d2d67e2 verified

A newer version of the Gradio SDK is available: 6.9.0

Upgrade

Article Generation Instructions

Writing Style Guidelines

  1. Voice: Use a conversational yet professional tone
  2. Perspective: Write in third person, but include first-person quotes from the interviewee
  3. Length: Aim for 1500-3000 words
  4. Audience: Other builders, founders, and project leaders who want to learn from real experiences, consider the readers may have worked for 20 years not learning new words and had left school since 8th grade, they want to contribute the community even with limited skills and knowledge

Structure Template

Title

  • Make it compelling and specific
  • Example: "How [Project] Solved [Problem] for [Users]" or "Building [Project]: From [Starting Point] to [Outcome]"

Opening Hook (1-2 paragraphs)

  • Start with the most compelling moment, challenge, or outcome
  • Make readers want to know the full story

The Spark (Background/Motivation)

  • What problem did they notice?
  • Why did they feel compelled to act?
  • What was their unique perspective?

The Journey

  • Key milestones and turning points
  • Major decisions with reasoning
  • Challenges faced and how they were overcome
  • Resources gathered (funding, people, tools)

The Team

  • How it formed
  • Who joined and why
  • How the team worked together and maintain momentum
  • Roles and dynamics

Building & Delivering

  • How the project was developed
  • Key technical or process decisions
  • How they reached users

Impact & Feedback

  • User reception
  • Measurable outcomes
  • Unexpected results

Lessons Learned

  • What worked well
  • What they'd do differently
  • Advice for others

Key Takeaways (Bullet points)

  • 3-5 actionable insights readers can apply

Formatting Rules

  • Use markdown headers (##, ###) for sections
  • Include relevant quotes in blockquotes (>)
  • Use bullet points for lists and takeaways
  • Bold key terms and important phrases
  • Keep paragraphs short (3-5 sentences max)

What Makes a Good Case Article

  1. Specificity: Include concrete numbers, dates, names when available
  2. Honesty: Don't shy away from failures or challenges
  3. Actionability: Every section should have something readers can learn from
  4. Story Arc: Build tension and resolution
  5. Human Element: Show the emotions, doubts, and victories