Ademola Thompsonsuperhero.hashnode.dev·Jan 8, 2025Understanding User Needs in Technical Writing: How Frameworks Like Diátaxis HelpSuccess in technical documentation is often measured by how helpful a document is to the end user (or reader). Many technical documents have a section on each page for users to give feedback and suggestions on improving the document. This shows that ...10 likesdiataxis
Rumaisa Navedrumaisanaveed.hashnode.dev·Jan 6, 2025How to add a good readme in your GitHub projectsDo you guys edit and customize your GitHub README file? If yes, then you're already on the right path! But if you don't, then let me guide you on this topic in this article. If you follow these guides, recruiters will only call you (I'm just kidding,...5 likes·49 readsREADME
Abhijit Gadhaveabhigadhave97.hashnode.dev·Jan 5, 2025Make a habit of reading documentation, design docsOne thing I missed during my initial days was reading the company’s internal design docs and documentation. During my internship, I didn’t understand many things, so I frequently asked my mentor and colleagues for help. Looking back now, I feel it wa...10 likes·30 readstehnology
Issyapi-echo.hashnode.dev·Jan 1, 2025How to Migrate Swagger Data to EchoAPI?Swagger is a reliable tool for writing API documentation, but its reliance on annotations and lack of permission control can hinder work efficiency. As a developer, creating API documentation is routine. For years, Swagger has been my default tool fo...APIs
maggiecoco-in.hashnode.dev·Jan 1, 2025Streamline Your API Development with EchoAPI's AI Parsing Import FeatureIn daily software development, do you often encounter situations where you receive an offline API documentation or need to debug an online third-party API? Typically, we have to copy and paste the API URLs, request parameters, and so on into debuggin...APIs
Roberta Smithroberta-blogs.hashnode.dev·Dec 30, 2024How Technical Communications Enables Developers with Amara Graham, CamundaWhat if the best documentation not only explained things, but about enabling? In the latest episode of the Knowledge Base Ninjas podcast, Amara Graham, Head of Developer Experience at Camunda, reveals how technical writers remake the developer experi...Technical writing
Lloyd Theophilus Osabutey-Anikonlloyd82.hashnode.dev·Dec 29, 2024Writing Good Technical Articles: A Comprehensive GuideIntroduction Technical writing is a critical skill in the technology industry. Whether you’re documenting a complex process, explaining a concept, or sharing your expertise, well-written technical articles can help you establish authority, educate ot...Technical writing
Stan Lost0012.dev·Dec 26, 2024Ruby 3.4 Documentation: A Step Towards Better Ruby DocumentationIntroduction Ruby 3.4 isn’t just about shiny language features; it also comes with meaningful documentation updates. Some of these changes are reflected in the content of docs.ruby-lang.org, while others are behind the scenes in RDoc, the official do...2 likes·1.7K readsdocumentation
Issyapi-echo.hashnode.dev·Dec 26, 2024EchoAPI Tutorial: Mastering Environment Setup, Token Configuration, and API Testing for DevelopersEchoAPI is a powerful tool that supports basic API debugging functions, allowing for customized interfaces, quick cloning of interfaces, and logical management of interfaces. It has a feature for quickly generating documentation that Postman lacks an...Testing
Parvanaapi-design.hashnode.dev·Dec 26, 2024Unlock Seamless API Development with EchoAPI: The All-in-One Solution for DevelopersEchoAPI supports simultaneous online editing for backend, frontend, and testing teams with real-time synchronization, making it usable even in offline environments. It combines functionalities from Postman, Swagger, Mocking, and flow testing into one...APIs
