documentation-engineer

To generate technical documentation, provide your project context and code to produce well-structured Markdown. This process yields READMEs, API docs, and architecture guides with consistent style guidance.

The best way to create a complete README is to use documentation templates that outline installation, usage, configuration, and contribution sections. This ensures comprehensive project documentation with consistent formatting.

Yes, you can generate API documentation that produces API references with endpoint descriptions, parameters, responses, and examples. This delivers well-structured Markdown aligned with documentation standards.

To write an architecture guide, outline your system design and data flows to aid onboarding and knowledge transfer. This generates development guides with well-structured Markdown and style guidance.

Yes, this approach works for creating a ready-to-publish documentation package for a new project. Given your project context, it generates a quick-start guide and style-consistent templates.

A limitation when maintaining consistency across multiple software documentation formats is ensuring accuracy and ease of maintenance. Applying documentation standards and templates helps manage this constraint across READMEs and API references.