Meet the Workflows: Documentation & Content
Step right up, step right up, and enter the documentation chamber of Peli’s Agent Factory! Pure imagination meets technical accuracy in this most delightful corner of our establishment!
In our previous post, we explored code quality and refactoring workflows - agents that continuously push our codebase toward better design, finding patterns and improvements that humans often miss. These workflows never take a day off, quietly working to make our code cleaner and more maintainable.
Now let’s address one of software development’s eternal challenges: keeping documentation accurate and up-to-date. Code evolves rapidly; docs… not so much. Terminology drifts, API examples become outdated, slide decks grow stale, and blog posts reference deprecated features. The question isn’t “can AI agents write good documentation?” but rather “can they maintain it as code changes?” Documentation and content workflows challenge conventional wisdom about AI-generated technical content. Spoiler: the answer involves human review, but it’s way better than the alternative (no docs at all).
Documentation & Content Workflows
Section titled “Documentation & Content Workflows”These agents maintain high-quality documentation and content:
- Daily Documentation Updater - Reviews and updates documentation to ensure accuracy and completeness
- Glossary Maintainer - Keeps glossary synchronized with codebase
- Technical Doc Writer - Generates and updates technical documentation
- Documentation Unbloat - Reviews and simplifies documentation by reducing verbosity
- Documentation Noob Tester - Tests documentation as a new user would, identifying confusing steps
- Slide Deck Maintainer - Maintains presentation slide decks
- Multi-device Docs Tester - Tests documentation site across mobile, tablet, and desktop devices
- Blog Auditor - Verifies blog posts are accessible and contain expected content
- Schema Consistency Checker - Detects inconsistencies between JSON schema, code, and documentation
Documentation is where we challenged conventional wisdom. Can AI agents write good documentation?
The Technical Doc Writer generates API docs from code, but more importantly, it maintains them - updating docs when code changes. The Glossary Maintainer caught terminology drift (“we’re using three different terms for the same concept”).
The Slide Deck Maintainer keeps our presentation materials current without manual updates.
The Multi-device Docs Tester uses Playwright to verify our documentation site works across phones, tablets, and desktops - testing responsive layouts, accessibility, and interactive elements. It catches visual regressions and layout issues that only appear on specific screen sizes.
The Blog Auditor ensures our blog posts stay accurate as the codebase evolves - it flags outdated code examples and broken links.
AI-generated docs need human review, but they’re dramatically better than no docs (which is often the alternative). Validation can be automated to a large extent, freeing writers to focus on content shaping, topic, clarity, tone, and accuracy.
Learn More
Section titled “Learn More”- GitHub Agentic Workflows - The technology behind the workflows
- Quick Start - How to write and compile workflows
Next Up: Issue & PR Management Workflows
Section titled “Next Up: Issue & PR Management Workflows”Beyond writing code and docs, we need to manage the flow of issues and pull requests. How do we keep collaboration smooth and efficient?
Continue reading: Issue & PR Management Workflows →
This is part 3 of a 16-part series exploring the workflows in Peli’s Agent Factory.