5 Tips For Writing Technical Documentation That Developers Love

This page summarizes the projects mentioned and recommended in the original post on dev.to

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.
surveyjs.io
featured
InfluxDB - Power Real-Time Data Analytics at Scale
Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
www.influxdata.com
featured
  • github-docs

    The open-source repo for docs.github.com

  • 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:

  • documentation

    Official documentation for Pieces for Developers (by pieces-app)

  • 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!

  • 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.

    SurveyJS logo
NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts

  • ice-blockchain

    11 projects | /r/ays23 | 11 Oct 2023
  • Musk vs. Zuck Poll

    1 project | news.ycombinator.com | 22 Jun 2023
  • docs/browser.js at dependabot/github_actions/actions/github-script-98814c53be79b1d30f795b907e553d8679345975 · github/docs

    1 project | /r/kucoin | 29 May 2023
  • GitHub outage again, even basic pages give HTTP 500

    1 project | news.ycombinator.com | 11 May 2023
  • Weird GitHub site bug. Can you confirm that it happens for you too?

    1 project | /r/github | 12 Apr 2023