Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Guides Overview

Practical guides to help you succeed with agentful in real-world development scenarios.

What You'll Learn

These guides go beyond the basics and teach you how to:

  • Write effective PRODUCT.md specifications that agentful understands perfectly
  • Set up agentful for team collaboration with shared configs
  • Troubleshoot common issues and resolve blockers quickly
  • Apply best practices learned from real agentful development
  • Avoid anti-patterns that slow down autonomous development

Guide Categories

Product Specification

Writing Effective PRODUCT.md

The foundation of successful autonomous development. Learn how to write clear, actionable specifications that guide agentful to build exactly what you want.

  • Structure and sections explained
  • Real examples from successful projects
  • Templates you can copy and adapt
  • Common dos and don'ts
  • How to handle ambiguity
  • Acceptance criteria best practices

Team Collaboration

Team Adoption Guide

Using agentful effectively in a team environment. Setup patterns, collaboration strategies, and configuration sharing.

  • Setting up team-wide agentful configs
  • Managing shared PRODUCT.md files
  • Collaboration workflows
  • Code review with agentful
  • Handling conflicting decisions
  • Onboarding team members

Problem Solving

Troubleshooting Guide

Common issues, their symptoms, and step-by-step solutions. Get unstuck fast when agentful doesn't behave as expected.

  • agentful seems stuck or spinning
  • Validation loops that never complete
  • Decision handling problems
  • State file corruption
  • Quality gate failures
  • Performance issues
  • Recovery strategies

Expert Tips

Best Practices

Learn from real agentful development experience. Proven patterns, anti-patterns to avoid, and optimization techniques.

  • Writing better features and requirements
  • Effective tech stack specifications
  • Progress tracking and monitoring
  • Iteration optimization
  • Code quality patterns
  • When to intervene vs. let agentful work
  • Scaling to large projects

How to Use These Guides

For Beginners

Start here if you're new to agentful:

  1. Quick Start - Get your first project running
  2. Writing Effective PRODUCT.md - Learn to write great specs
  3. Best Practices - Understand what works well

For Teams

Adopting agentful across a team? Read these:

  1. Team Adoption Guide - Setup and workflows
  2. Writing Effective PRODUCT.md - Standardize specs
  3. Troubleshooting Guide - Handle team issues

For Experienced Users

Already comfortable with agentful? Dive deeper:

  1. Best Practices - Advanced patterns
  2. Troubleshooting Guide - Debug complex issues
  3. Team Adoption Guide - Scale to teams

Real Examples Throughout

All guides include:

  • Real code examples from actual agentful projects
  • Before/after comparisons showing improvements
  • Templates you can copy and adapt
  • Checklists for common tasks
  • Cross-references to related documentation

Contributing

Found a pattern that works well? Have a troubleshooting story to share?

Contributions to these guides are welcome! See the Contributing Guide for details.

Quick Reference

Essential Guides:
You want to...Read this guide
Write better specsWriting Effective PRODUCT.md
Set up for your teamTeam Adoption
Fix a problemTroubleshooting
Improve resultsBest Practices
Key Concepts: Common Tasks:

Next: Learn to write effective PRODUCT.md files