PinnedJoanna SuauinUX CollectiveHow to write and design good API documentationThis is a pre-publication of some thoughts I shared with Thomas Bohm, the Director of User Design, Illustration and Typesetting journal for…Mar 18, 2022Mar 18, 2022
Joanna SuauinBootcampCreating Multilingual Developer Documentation: Best Practices for Localization and TranslationLearn best practices for multilingual dev docs: plan for localization, write clearly, collaborate with translators, and use automation…Jun 30, 20231Jun 30, 20231
Joanna SuauinBootcamp10 Tips for Creating Quality Developer DocumentationLearn 10 tips for effective documentation that plays a crucial role in enabling developers to understand, use, and contribute to projects.Jun 12, 2023Jun 12, 2023
Joanna SuauinBootcampHow to adopt a docs-as-code approach for developer documentationLearn how to adopt a docs-as-code approach to developer documentation and why it’s important to do so.May 13, 2023May 13, 2023
Joanna SuauinBootcampWhy docs-as-code peer review should be part of your dev cycleThis post discusses the benefits and introduces the concept of docs-as-code, a methodlogy that treats documentation like source code.Jul 27, 2023Jul 27, 2023
Joanna SuauinBootcampDocs user feedback and how to deal with itThe article explores different user feedback strategies and how to act upon feedback itself to improve user journey.Dec 22, 20221Dec 22, 20221
Joanna SuauKudos for putting documentation so high up your list!Personally, I think that API documentation is a UI for its users so it's extremely important to get it right, keep it up-to-date, and keep…Dec 19, 20223Dec 19, 20223
Joanna SuauI've been a technical writer for more than 10 years and this is a great recap of the major concepts…One thing to add about the developer-oriented content and its target audience:Dec 19, 2022Dec 19, 2022
Joanna SuauI suffer from a huge blank page block. Jack Torrence from The Shinning level huge!Whenever I start something new, I freeze. To conquer that, I have designed a number of templates for different content types. So if I want…Nov 18, 2022Nov 18, 2022
Joanna SuauGreat read!I would argue a bit the statement where you say that monolith architecture is simple and it's easier to deploy a new feature.Nov 16, 2022Nov 16, 2022