technical-writer

To write a README developers read, provide structured inputs like project purpose, installation steps, and minimal usage examples to generate scannable, Markdown-formatted documentation. This reduces onboarding friction by ensuring essential setup and usage details are clear and actionable.

Documenting an OpenAPI or Swagger API reference requires providing API schemas and code examples to produce accurate, style-guide-compliant Markdown outputs. This ensures example requests, parameters, and errors are clearly presented for engineering teams consuming the API.

Creating a runbook or postmortem template for incident response involves providing structured inputs like system architecture and incident timelines. This produces fast, scannable Markdown templates that accelerate incident response and document learning for future prevention.

You need an Architecture Decision Record (ADR) when making significant technical choices that require documentation and team alignment. Structure an ADR by providing the project purpose and architectural context to generate a standardized, Markdown-formatted decision log.

Yes, generating release notes from changelogs is supported by providing structured inputs like version updates and acceptance criteria. It produces Markdown-formatted, scannable changelogs that ensure contribution guidance and changes are clearly documented for recurring maintenance.

An onboarding guide for a new engineering team member should include installation steps, minimal usage examples, and API endpoints. Providing these structured inputs generates a scannable, checklist-driven Markdown document that reduces onboarding friction and accelerates developer productivity.