Looking for tech documentation solution

So I'm on the lookout for something, but I don't know how to briefly describe it. I want something to help me document various projects at work. It's not uncommon for me to spend a week setting something up, and it works for 2 years and then has a problem -- and I have to re-learn everything about it from the ground up before I can start solving it. For example, I'm setting up a new VMWare server today, and I just know I'm going to forget some of the details on it -- so I want to be able to type out some of the specs and processes, maybe use some tags, a coupel hyperlinks to more info, and be able to search for it a year from now. Does that make sense? Anybody have any suggestions?

mws,

I just have a bunch of text files (org) and sync them on all my computers with Syncthing. Works great so far.

stevo,

i use Obsidian to write my docs. then i publish to Confluence which is our internal repository.

johntash,

Bookstack is a really nice wiki/documentation tool.

You may also like wiki.js or even just storing markdown files in a git repo. Lately I’ve been using Obsidian to manage some notes about servers, but am thinking of going back to bookstack to “publish” docs for others.

Tiritibambix,
@Tiritibambix@lemmy.ml avatar

Bookstack is absolutely great. I have all my selfhosting knowledge written there from when I started 2 years ago. It is so great that I’ve started documenting stuff for other hobbies and for work.

poVoq,
@poVoq@slrpnk.net avatar

If it is just for yourself one of the many note taking applications that sync with a server should do. Many people also swear by Org mode for that.

If it is for a team, a easy to use Wiki work well. Personally I like Bookstack, but Dokuwiki is also good.

  • All
  • Subscribed
  • Moderated
  • Favorites
  • •
  • selfhost@lemmy.ml
  • khanakhh
  • magazineikmin
  • mdbf
  • GTA5RPClips
  • everett
  • rosin
  • Youngstown
  • tacticalgear
  • slotface
  • ngwrru68w68
  • kavyap
  • DreamBathrooms
  • thenastyranch
  • tester
  • JUstTest
  • ethstaker
  • cubers
  • osvaldo12
  • cisconetworking
  • Durango
  • InstantRegret
  • normalnudes
  • Leos
  • modclub
  • anitta
  • provamag3
  • megavids
  • lostlight
  • All magazines
    •