---
title: Revise Architecture Doc
description: Update an architecture document to reflect current codebase state
category: documentation
author: Joshua Levy (github.com/jlevy) with LLM assistance
---
Review and update an architecture document to ensure accuracy with current code.

## Steps

1. **Read the document**: Understand the existing architecture description

2. **Read referenced code**: Review all code files mentioned in the document

3. **Review related code**: Systematically examine related code to identify:
   - Sections that are correct and current
   - Gaps or missing information
   - Inaccuracies or outdated content

4. **Research updates**: Search for current information on:
   - Best practices for the patterns/approaches used
   - Latest docs for libraries and frameworks mentioned

5. **Revise the document**: Update to reflect current state
   - Preserve existing structure and style where possible
   - Update all outdated or inaccurate sections

6. **Add Future Considerations section** with:
   - **Open Questions**: Possible bugs, issues, or design uncertainties
   - **Potential Improvements**: Ideas for future enhancements

<!-- This document follows common-doc-guidelines.md.
See github.com/jlevy/practical-prose and review guidelines before editing.
-->
