Content Expert

The Content Expert agent specializes in technical writing, documentation, blog posts, release notes, API documentation, SEO optimization, and content strategy for developer-focused products.

Expertise Areas#

  • Technical Documentation - Getting started guides, tutorials, API references
  • Blog Posts - Technical articles, announcements, tutorials
  • Release Notes - Version updates, changelogs, migration guides
  • README Files - Project overviews, quick starts, contribution guides
  • API Documentation - Endpoint docs, code examples, error handling
  • Content Strategy - Planning, SEO, localization, style guides

Usage Examples#

Documentation Strategy#

Use the content-expert agent to create a documentation structure for a CLI tool.

Response includes:

  • Documentation architecture
  • Getting started guide outline
  • API reference structure
  • Content style guide

Blog Post Creation#

Use the content-expert agent to write a blog post announcing a new feature.

Response includes:

  • Compelling headline options
  • Introduction with hook
  • Feature benefits and use cases
  • Code examples
  • Call to action

Release Notes#

Use the content-expert agent to generate release notes for version 2.0.

Response includes:

  • Highlights section
  • New features with examples
  • Improvements and bug fixes
  • Breaking changes with migration guides
  • Upgrade instructions

Best Practices Applied#

1. Documentation Structure#

  • Getting Started (5-minute quick win)
  • Concepts (mental models)
  • Guides (task-oriented)
  • Reference (complete API)
  • Examples (real-world)

2. Writing Style#

  • Active voice
  • Imperative mood for instructions
  • One idea per sentence
  • Code examples for every concept
  • Define jargon on first use

3. SEO for Technical Content#

  • Target long-tail keywords
  • Answer specific questions
  • Include table of contents
  • Use schema markup for code
  • Optimize for featured snippets

4. Content Types#

  • Educational content
  • Announcement posts
  • Tutorial deep-dives
  • Case studies
  • Comparison guides

Common Patterns#

Documentation Template#

1# Feature Name 2 3Brief description of what this feature does. 4 5## Prerequisites 6 7- Requirement 1 8- Requirement 2 9 10## Quick Start 11 12\`\`\`bash 13# Get started in 30 seconds 14npx bootspring init 15\`\`\` 16 17## Step-by-Step Guide 18 19### Step 1: Setup 20 21[Instructions with code] 22 23### Step 2: Configuration 24 25[Configuration details] 26 27## API Reference 28 29| Method | Description | 30|--------|-------------| 31| `method()` | Does something | 32 33## Troubleshooting 34 35### Common Issue 36 37**Problem:** Description 38 39**Solution:** How to fix

Blog Post Template#

1--- 2title: "How to [Achieve Goal] with [Tool]" 3description: "Learn how to..." 4date: "2024-01-01" 5author: "Team" 6tags: ["tag1", "tag2"] 7--- 8 9## Introduction 10 11[Hook - Why should the reader care?] 12 13[Problem - What pain point are we addressing?] 14 15## The Solution 16 17[What we're proposing] 18 19## Implementation 20 21### Step 1 22 23\`\`\`typescript 24// Code example 25\`\`\` 26 27## Key Takeaways 28 291. **Point 1** - Explanation 302. **Point 2** - Explanation 31 32## Next Steps 33 34[Call to action]

Release Notes Template#

1# v2.0.0 Release Notes 2 3> Released on January 1, 2024 4 5## Highlights 6 7- **Feature 1** - What it does and why it matters 8- **Feature 2** - What it does and why it matters 9 10## What's New 11 12### Feature Name 13 14Description with example: 15 16\`\`\`bash 17bootspring new-command 18\`\`\` 19 20## Improvements 21 22- Improved X by doing Y 23- Enhanced performance of Z 24 25## Bug Fixes 26 27- Fixed issue where X caused Y (#123) 28 29## Breaking Changes 30 31### Change Name 32 33**What changed:** Description 34 35**Migration:** 361. Step 1 372. Step 2

API Documentation Template#

1## Create Resource 2 3Creates a new resource. 4 5**Endpoint:** `POST /api/v1/resources` 6 7**Authentication:** Bearer token required 8 9**Request Body:** 10 11\`\`\`json 12{ 13 "name": "string", 14 "type": "string" 15} 16\`\`\` 17 18**Response:** 19 20\`\`\`json 21{ 22 "id": "abc123", 23 "name": "My Resource", 24 "createdAt": "2024-01-01T00:00:00Z" 25} 26\`\`\` 27 28**Error Codes:** 29 30| Status | Code | Description | 31|--------|------|-------------| 32| 400 | INVALID_INPUT | Validation failed | 33| 401 | UNAUTHORIZED | Invalid token |

CLI Integration#

Generate content directly from the CLI:

1# Create a blog post template 2bootspring content new blog-post --title "Getting Started with Bootspring" 3 4# Generate release notes 5bootspring content new release-notes --version 2.0.0 6 7# Create API documentation 8bootspring content new api-doc --title "Create User Endpoint" 9 10# Generate a tutorial 11bootspring content new tutorial --title "Building Your First App"

Sample Prompts#

TaskPrompt
Docs structure"Create a documentation plan for our API"
Blog post"Write a launch announcement for feature X"
Release notes"Generate release notes for v1.2.0"
README"Create a README for our npm package"
Tutorial"Write a step-by-step tutorial for authentication"

Configuration#

1// bootspring.config.js 2module.exports = { 3 agents: { 4 customInstructions: { 5 'content-expert': ` 6 - Use active voice and imperative mood 7 - Include code examples for all concepts 8 - Target developer audience 9 - Optimize for SEO and discoverability 10 - Keep sentences concise and scannable 11 `, 12 }, 13 }, 14 content: { 15 strategy: 'developer', 16 style: 'technical', 17 seo: 'high', 18 platform: 'builtin', 19 }, 20};

Content Workflow#

  1. Plan - Define audience, goals, keywords
  2. Draft - Use templates and agent guidance
  3. Review - Technical accuracy check
  4. Optimize - SEO and readability
  5. Publish - Format and distribute
  6. Maintain - Update and refresh