Ask HN: Any Sugestions for Proceures Documentation?

This page summarizes the projects mentioned and recommended in the original post on news.ycombinator.com

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

    🃏 A magical documentation site generator.

  • The tools to author it aren't that important, frankly. Ask your audience what they're most comfortable using and try to meet them there.

    If the stakeholders are technical, you have more options. If they aren't, I hope you like Google Docs or Word, because if you give them anything other than that or a PDF, they'll probably complain. At worst, yeah, write it in a long Markdown text file and use tools like pandoc to transform that into other formats as needed.

    If you do need a website and you're not generating enterprise-scale amounts of content (and it sounds like you're not) try things that let you avoid needing build steps and infrastructure if at all possible, so you can iterate and deploy changes with as little friction as you can.

    Tools like Docsify[1] can take a pile of Markdown files and serve a site out of them, client- or server-side, without a static build step. Depending on the org, you can get away with GitHub's default rendering of Markdown in a repo. Most static site builds for stuff your scale are overengineered instances of premature optimization.

    Past those initial hurdles, the format and tools challenges are all in maintenance. How can you:

    - most easily keep the content up to date

    - delegate updates as the staff grows or changes

    - proactively distribute updates ASAP to the people who'd most benefit from receiving them

    That's going to depend a lot more on who'll contribute updates, what their technical proficiency's like, and how they prefer to communicate. It might be a shared git repo and RSS or Slack notifications if they're comfortable with those things, and it might be a Google Doc and email if they're like most non-technical stakeholders.

    1: https://docsify.js.org

  • 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

  • Cookbook for SH-Beginners. Any interest? (building one)

    2 projects | /r/selfhosted | 10 Jul 2023
  • Common Lisp - "The Tutorial" Part 12 - Macros

    1 project | /r/lisp | 23 Mar 2022
  • Ask HN: Good designs for a website that serves as a detailed FAQ?

    1 project | news.ycombinator.com | 16 Feb 2022
  • Docsify – A magical documentation site generator

    1 project | news.ycombinator.com | 22 Jan 2022
  • Docsify: A magical documentation site generator

    1 project | news.ycombinator.com | 20 Sep 2021