BMAD Tech Writer Project

A BMAD Method project featuring an intelligent Tech Writer agent for automated documentation generation.

Table of Contents

• Features
• Prerequisites
• Installation
• Usage
• Project Structure
• Configuration
• Testing
• Contributing
• License
• Support

Features

• ✨ Tech Writer Agent: Automated documentation generation
• 📝 Smart Templates: Pre-configured documentation templates
• 🚀 Easy Integration: Works with BMAD Method ecosystem
• 🔧 Configurable: Adjustable reading levels and formats
• 📚 Multiple Formats: Supports README, API docs, and user guides

Prerequisites

Before you begin, ensure you have the following installed:

• BMAD Method framework
• Text editor or IDE
• Git for version control

Installation

Follow these steps to get your development environment running:

1. Clone the repository:

   git clone <repository-url>
   cd codespaces-blank

2. Ensure BMAD core is properly configured:

   ls .bmad-core/

3. Activate the Tech Writer agent:

   # Use your BMAD activation command
   /BMad:agents:tech-writer

Usage

The Tech Writer agent provides several commands for documentation tasks.

Quick Start

# Activate the Tech Writer agent
/BMad:agents:tech-writer

# Generate a README
*generate-readme

# Update existing documentation
*update-docs

Examples

Generate README for your project:

1. Activate the Tech Writer agent
2. Run *generate-readme
3. Review the generated README.md

Update documentation after code changes:

1. Make your code changes
2. Activate Tech Writer
3. Run *update-docs

Project Structure

codespaces-blank/
├── .bmad-core/           # BMAD Method core files
│   ├── agents/           # Agent definitions
│   │   └── tech-writer.md  # Tech Writer agent
│   ├── tasks/            # Executable tasks
│   │   ├── analyze-project.md
│   │   └── generate-documentation.md
│   └── templates/        # Document templates
│       └── readme-tmpl.md
├── docs/                 # Project documentation
│   ├── stories/          # User stories
│   │   ├── 1.1.story.md  # Create Tech Writer Agent
│   │   └── 1.2.story.md  # Implement README Generation
│   └── prd-tech-writer-agent/  # Product requirements
└── README.md             # This file

The project follows the BMAD Method structure with agents, tasks, and templates organized in the .bmad-core directory.

Configuration

The Tech Writer agent can be configured through its agent definition:

• Reading Level: Set to 8th grade by default
• Format: Markdown (default), HTML, PDF options
• Examples: Include code examples automatically
• Diagrams: Auto-generate when appropriate

Testing

To test the Tech Writer functionality:

1. Run the agent activation test
2. Generate a sample README
3. Verify all sections are populated
4. Check markdown formatting

Contributing

We welcome contributions! Please see our contributing guidelines:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development Setup

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

See LICENSE file for details

Support

For support, please:

• Check the documentation in the docs/ folder
• Review existing user stories
• Contact the BMAD Method community

---

Generated with Tech Writer Agent - 2025-09-16