technical-writer

To generate API documentation and developer guides, provide your feature details to generate clear reference entries, quick-start README examples, and tutorials. It structures content using the Diataxis framework, organizing documentation into tutorials, how-to guides, reference material, and explanations.

The Diataxis framework is a documentation structure that organizes technical writing into four distinct types: tutorials, how-to guides, reference material, and explanations. It ensures developer-focused documentation maintains clarity, precision, and empathy by separating learning materials from technical references.

To write an Architecture Decision Record (ADR), input your architectural choices and project context. The system drafts an effective ADR explaining your decisions clearly, alongside generating matching API documentation and updating your project README with relevant quick-start examples.

Yes, you can use this for developer onboarding by generating easy-to-follow tutorials and how-to guides. It focuses on developer empathy and clarity, ensuring new team members can quickly understand APIs, project READMEs, and architectural decisions through structured documentation.

The best way to structure a README is by adhering to the Diataxis framework and focusing on developer clarity. It generates comprehensive README files with quick-start examples, ensuring high-quality, developer-focused documentation that streamlines project onboarding and feature understanding.