What do people use to build websites for documentation for their framework/library?
How would you go about making a website that generates pdf based on user input?
How to write great documentation?
Always have someone who didn't code a feature write the documentation for it.
Always explain first and foremost how to quickly do things the most common way, before delving deeper into the "tips and tricks" doco.
Don't assume your users are as familiar with underlying technologies as you are. Link to the relevant upstream doco if need be.
The doco needs to:
-
Be easily understood by a first-time skim reader possibly doing a market scan of similar products
-
Offer enough basic instruction to get the user up and running quickly
-
Be a good enough technical resource that the even advanced users can get value out of it
-
Not be overly wordy. Examples are always more useful than a wall of text
How to make/create a documentation website?
What is an AI documentation website builder?
Can I customize templates in an AI documentation builder?
Is coding knowledge required to use an AI documentation builder?
Factsheet
/ August 30, 2024; 2 years ago
/ August 30, 2024; 2 years ago
So I'm looking at some websites like Jest, React, or really any website that's for a framework/library, and I'm wondering if people use a specific framework, or some kind of static site generator. Since most of these websites are just static, I would assume they probably use a framework like Gatsby or something. I'm also aware that some people may use some documentation generator. Do you guys know of any tools?