Our great sponsors
-
-
-
SurveyJS
Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.
In college, an English professor would ask me and other students the following question when reviewing our essays, “Where are the examples?” Developers ask the same question when reading your documentation. To write good technical writing documents, include examples that developers can see themselves implementing in their work. How can this be done? By adding examples from your product’s codebase! 🙂 Let’s look at this code snippet from my contribution to GitHub’s documentation:
Whether it is an explainer page or a tutorial, accessibility, balanced language, real-world examples, clear explanations, and your voice are the key factors in writing technical documentation that aids developers in their work. If you’re looking for a place to put this into practice, check out Pieces for Developer’s documentation repository on GitHub. Now, go forth and write excellent technical documentation!