Melanie Guyot
Ansys / Synopsys Inc.
From diversity to cohesion: Unifying library-based API documentation for the Ansys Developer Portal
SESSION
This presentation outlines Ansys’s journey from fragmented API documentation formats to a unified, Markdown-based system centralized on the Developer Portal. It highlights the challenges of inconsistent tools and structures, the strategic shift to Markdown, contributor enablement through templates and training, and the benefits of improved collaboration, reduced maintenance, and enhanced developer experience. The roadmap concludes with future plans for AI-assisted documentation and automated publishing workflows.
PRESENTER
Melanie is a Senior API Documentation Specialist at Ansys, part of Synopsys Inc.
Her background spans both software development and technical writing. She started as a developer in 2001 before transitioning into documentation, working with tools like Doxygen, Help & Manual, and later full docs-as-code environments. Since joining Ansys in 2023, she's been working with Paul to coordinate the developer documentation strategy across the company.
Our goal is simple: improve consistency, quality, and efficiency for all the API and library-based APIs we expose. And ultimately, make things clearer and more discoverable for the developers using our products.
Follow her on Linkedin.
