How would you write project-specific documentation?

This page summarizes the projects mentioned and recommended in the original post on /r/AskProgramming

Our great sponsors
  • SurveyJS - Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • WorkOS - The modern identity platform for B2B SaaS
  • Docusaurus

    Easy to maintain open source documentation websites.

    Which tools are you using for documentation? We've come to a conclusion that Confluence might not be the best fit because files can't be easily searched in it. I've heard about https://docusaurus.io/, but haven't studied it yet.

  • storybook

    Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.

    I think there are two audiences for this: Users, who will need help documentation how to do things, and devs/UX. I find storybook a good tool for dev/ux colllaboration, and you end up with living documentation here.

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

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