Which documentation system do you recommend?
Hey Makerlog,
I want (no must :D) to document my software now. Does anyone know good documentation software I can use for this?
The following are my requirements:
- Self hosted
- Doc should be searchable
- No python, pearl
- PHP, NodeJS prioritized
- WYSIWYG Editor (because of editors)
- Can require DB (MySQL, MariaDB)
I wanted to use first markdown stuff, but it's hard to implement for non-technical people, additionally a search is a bit more complex to implement.
Thanks for every answer
I use the IDE built-in annotations. In my case apigen - which is perfectly fine for my needs.
You can start right now just annotate any new function you write and once in a while generate/(auto)update your docs. That's also the best approach instead of being overwhelmed with documenting all your previous code at once..
There are also enough options to auto-create annotations you can just exten d with descriptions, links…
ps.: there might be more uptodate alternatives. But my IDE had it supported by default back then so I sticked with it so far.
Hmm, that's not what I'm looking for. In code documentation exists already. I want to write a real user documentation now. The problem is, not only me, but also editors will work on it.
Topics are how a user / editor, administrator uses my software. In my case this is a content management system, e-commerce system … and more.
So I want to write not a developer documentation, but an end user documentation
Do Raneto or Docsify fit what you're after? Or perhaps https://stoplight.io/, which is geared towards APIs but (I think) has markdown and writing features.
At the moment I tend to be docsify in Combination with Stoplight Studio. Looks ok so far. I did not know Stoplight yet, thanks for the link.
Why not using https://youneedawiki.com/ ? Docs are on top of Google docs, and it's made by an idie maker.
Simples
The idea is cool but there is too much against it.
- we are more than 10 people, then it will be "expensive"
- I want to self host it.
If the servers are down or not available, the documentation is gone. Of course, self hosting is on top of my prio list. The documentary is still there as Google Docs, but same game. I want the stuff on my PC / Laptop.
Please sign in to leave a comment.