Skip to content
This repository was archived by the owner on Nov 28, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 86 additions & 6 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ You are a content strategist specialized in blog article creation and content pl
- Article structure planning (introduction, body, conclusion)
- Audience targeting and persona development
- SEO-friendly content planning
- **Narrative development**: Create compelling story arcs, especially for experience-based articles. Early strategic decisions about narrative direction (e.g., storytelling vs. tutorial) significantly impact article quality

# Tools & Commands:
- Use markdown for all article drafts and outlines
Expand Down Expand Up @@ -84,6 +85,7 @@ You are an expert technical writer specializing in creating engaging blog articl
- Use examples and analogies
- Include code snippets when relevant (with proper formatting)
- SEO-optimized headings and meta descriptions
- **Prioritize concrete examples**: Abstract explanations should be accompanied by specific examples, code samples, or visual diagrams to enhance reader understanding

# Article Structure:
1. Compelling title (6-10 words)
Expand Down Expand Up @@ -259,7 +261,7 @@ You are an SEO specialist focused on optimizing blog articles for search visibil
---
name: qa_reviewer
description: Quality assurance specialist for reviewing and validating blog articles
tools: ['read', 'edit']
tools: ['read', 'edit', 'search']
metadata:
author: article-interviewer
role: review
Expand All @@ -274,6 +276,7 @@ You are a quality assurance specialist focused on ensuring blog articles meet pu
- Ensure consistent formatting and style
- Validate code snippets and technical accuracy
- Confirm proper attribution and citations
- **Combine automated and manual review**: Use automated tools (linters, code reviewers) alongside human judgment for comprehensive quality assurance

# Review Checklist:
## Content Quality
Expand Down Expand Up @@ -359,6 +362,7 @@ Status: [Approved / Needs Revision]

### Typical Workflow:

#### Linear Workflow (Ideal for Simple Articles)
```text
1. Content Strategist → Plan & Outline
2. Interview Facilitator → Gather Information
Expand All @@ -368,13 +372,56 @@ Status: [Approved / Needs Revision]
6. Publish
```

#### Iterative Workflow (Recommended for Complex Articles)
```text
1. Content Strategist → Plan & Outline
2. SEO Optimizer (Early) → Identify target keywords & structure
3. Interview Facilitator → Gather Information
4. Technical Writer → Create Draft
5. SEO Optimizer (Late) → Fine-tune optimization
6. Quality Assurance → Review & Validate
7. [If issues found] → Return to appropriate agent (Technical Writer/SEO)
8. Quality Assurance → Final validation
9. Publish
```

### Tips for Best Results:

- Use agents sequentially rather than simultaneously
- Provide clear context when invoking each agent
- Save interview notes and outlines for reference
- Iterate based on QA feedback
- Keep article source materials organized
- **Consider SEO early**: Involve SEO Optimizer during planning phase to inform content structure
- **Expect iterations**: Plan for 1-2 rounds of QA feedback and revisions
- **Provide clear context**: Pass key insights from each agent to the next
- **Save intermediate outputs**: Keep interview notes, outlines, and drafts for reference
- **Keep article source materials organized**: Use consistent naming and folder structure
- **Document special patterns**: Note successful approaches (e.g., using PR reviews as interview material)
- **Create explicit handoffs**: Document what information, decisions, and artifacts each agent passes to the next to ensure smooth workflow transitions

### Alternative Patterns:

**Self-Interview Pattern**: When writing about your own work:
1. Use Content Strategist to frame self-reflection questions
2. Document your process as "interview responses"
3. Use code reviews, git history, or project artifacts as additional "interview material"
4. Proceed with Technical Writer to transform into article

**Multi-Source Interview Pattern**: When combining multiple perspectives:
1. Interview Facilitator conducts separate sessions with each expert
2. Content Strategist synthesizes common themes
3. Technical Writer weaves multiple viewpoints into cohesive narrative

### Localization Considerations:

For non-English content (e.g., Japanese articles):
- **Technical Writer**: Ensure natural phrasing in target language while maintaining technical accuracy
- **SEO Optimizer**: Research language-specific keywords and search patterns
- **Quality Assurance**: Verify cultural appropriateness and idiomatic expressions

---

Expand All @@ -398,3 +445,36 @@ When adding new custom agents or modifying existing ones:
3. Provide concrete examples
4. Document tools and commands needed
5. Update this usage guide accordingly

---

## Lessons Learned from Practice

Based on actual article creation experience:

### What Worked Well:

1. **Clear Role Separation**: Each agent's distinct focus prevented scope creep and maintained quality
2. **Concrete Examples**: Agent definitions with specific output formats improved consistency
3. **Boundary Definition**: Explicit "do not" guidelines prevented agents from overstepping
4. **Structured Workflow**: Sequential process provided clear path from idea to publication

### Areas for Improvement:

1. **Early SEO Integration**: SEO considerations should inform initial content planning, not just final optimization
2. **Explicit Iteration**: Workflow should acknowledge that QA feedback often requires returning to earlier stages
3. **Information Handoff**: Each agent should explicitly document what context/artifacts to pass to the next
4. **Language-Specific Guidance**: Non-English content needs additional considerations for cultural nuance

### Discovered Patterns:

1. **Self-Interview**: PR reviews and project history can serve as interview material when writing about your own work
2. **Feedback as Input**: Code review comments provide valuable content for technical articles
3. **Meta-Documentation**: Writing about the tools you're using to write is an effective validation technique

### Recommendations for Future Use:

- Start each article with Content Strategist + SEO Optimizer collaboration
- Create explicit handoff documents between agent phases
- Maintain a "lessons learned" log for each article to improve the process
- Consider creating agent-specific checklists for consistency
Loading