Readme Maintenance

Create or update project README with current information

Complexity: Simple | Duration: 5-15m | Category: Documentation

Tags: readme documentation onboarding

Workflow Diagram

Steps

Step 1: Content audit

Agent: codi

documentation-writer - Review current README

Step 2: Structure update

Agent: codi

documentation-writer - Ensure standard sections present

Step 3: Installation instructions

Agent: codi

documentation-writer - Update setup steps

Step 4: Usage examples

Agent: codi

documentation-writer - Add/update code examples

Step 5: Badge updates

Agent: codi

documentation-writer - Update status badges

Step 6: Review

Agent: component

qa-reviewer - Verify accuracy and clarity

Usage

To execute this workflow:

/workflow documentation/readme-maintenance.workflow

Related Workflows

See other workflows in this category for related automation patterns.