Live data from Hacker News

Ask HN: Which Wiki or internal documentation tools do you use?

news.ycombinator.com

61–70 of 77 posts

Re: Ask HN: Which Wiki or internal documentation tools do you use?

#61
post #14

> Some basic requirements are: - searchable - code snippets - hyperlinking I think another requirement to add is diagramming. I think wiki-style diagramming would be a big help for programmers to better communicate ideas. I've used external tools like draw.io but the overhead for editing, downloading, and uploading I feel gets in the way. Sadly, we are on confluence but don't use the draw.io plugin [1]. Built-in supp…

The PlantUML plugin for confluence is free and works great for us.

Re: Ask HN: Which Wiki or internal documentation tools do you use?

#62
post #18

Confluence. It's not bad. It's not great either. Which is pretty much the best way to describe all Atlassian products. It's unbearable on slow or spotty internet connections. It's riddled with bugs (just the other day my spacebar literally stopped working in their edit view). The formatting gets in your way more than markdown, but at least not as much as something like OneNote. But, it's powerful. Like any Atlassian…

The worst bug (or bad design if you wish) I've seen in confluence is the following - permissions on pages are inherited in a tree-like manner, parent to child. A reindex wasn't done and at some point child pages with sensitive information became viewable to every user because the permissions were not re-applied.

I would absolutely never rely on the permissions in Confluence to store anything sensitive in it ever again.

Re: Ask HN: Which Wiki or internal documentation tools do you use?

#63
post #44

I'd be curious if anyone can summarize the tradeoffs between Confluence + MediaWiki at some point. From what I've seen it seems to come down to: (1) MediaWiki is definitely more responsive (Confluence can be quite slow) and, importantly, considerably more expressive -- provide you can learn Markdown, which basically anyone can. (2) But you're essentially stuck with email-based logins which can be a dealbreaker to som…

I find that the admin side of Mediawiki is downright painful. Installing plugins requires mucking around in a config file on the server (it’s just another PHP app), and any errors in that file lead to a blank white page, rather than a useful error message. I also found scaling MW harder than Confluence, as unintuitive as that sounds. Same goes for troubleshooting speed problems.

Good to know - thanks

Re: Ask HN: Which Wiki or internal documentation tools do you use?

#65
I'm a fan of WikiJS. Though I havent personally gone through setting it up, the last two web projects I worked on used it. I found the UI intuitive and easy to use. I loved being able to updates either in a code editor or in the browser UI.

https://wiki.js.org/ https://github.com/Requarks/wiki

Re: Ask HN: Which Wiki or internal documentation tools do you use?

#66
post #62
post #18

Confluence. It's not bad. It's not great either. Which is pretty much the best way to describe all Atlassian products. It's unbearable on slow or spotty internet connections. It's riddled with bugs (just the other day my spacebar literally stopped working in their edit view). The formatting gets in your way more than markdown, but at least not as much as something like OneNote. But, it's powerful. Like any Atlassian…

The worst bug (or bad design if you wish) I've seen in confluence is the following - permissions on pages are inherited in a tree-like manner, parent to child. A reindex wasn't done and at some point child pages with sensitive information became viewable to every user because the permissions were not re-applied. I would absolutely never rely on the permissions in Confluence to store anything sensitive in it ever agai…

Yeah, we have a corporate policy of never storing anything critically sensitive in an Atlassian product. Though, to be fair, we have the same policy for Slack and most of our tools; that stuff never leaves Amazon.

Re: Ask HN: Which Wiki or internal documentation tools do you use?

#67

I'm a fan of WikiJS. Though I havent personally gone through setting it up, the last two web projects I worked on used it. I found the UI intuitive and easy to use. I loved being able to updates either in a code editor or in the browser UI. https://wiki.js.org/ https://github.com/Requarks/wiki

We also use WikiJS, it is great. The fact that all the articles are stored and checked into Git in the background is great for keeping track of who edits what, undoing accidental changes, and keeping the wiki content agnostic to the platform.

That being said, there is room for improvement. Image handling is not great, and a lot of the components feel simplistic and could be fleshed out (permissions, indexing/search). Dead simple to set up though, especially with Docker-compose.

Re: Ask HN: Which Wiki or internal documentation tools do you use?

#68
post #43
post #18

Confluence. It's not bad. It's not great either. Which is pretty much the best way to describe all Atlassian products. It's unbearable on slow or spotty internet connections. It's riddled with bugs (just the other day my spacebar literally stopped working in their edit view). The formatting gets in your way more than markdown, but at least not as much as something like OneNote. But, it's powerful. Like any Atlassian…

If you want something similar to Dropbox Paper, but better optimized towards long-term documentation, you should give Nuclino ( https://www.nuclino.com ) a try. In terms of organization capabilities it is similar to Confluence. But I'm the CTO so I'm obviously biased.

This looks perfect for what I'm looking for. But I need to serve it to MY customers along our software. Is there any way do that?

Feel free to contact me directly. moura @ the domain in my profile

Re: Ask HN: Which Wiki or internal documentation tools do you use?

#69
post #44

I'd be curious if anyone can summarize the tradeoffs between Confluence + MediaWiki at some point. From what I've seen it seems to come down to: (1) MediaWiki is definitely more responsive (Confluence can be quite slow) and, importantly, considerably more expressive -- provide you can learn Markdown, which basically anyone can. (2) But you're essentially stuck with email-based logins which can be a dealbreaker to som…

I'll give it a shot, but I am the entire IT/DevOps/pe department for my company. It boils down to one thing: hosted so I don't have to do shite. Along with the fact that we use bitbucket, so peeps are already logged on, this makes me terribly happy. As for the best wiki I ever used, was the FB internal one, I think it was based on Mediawiki, but I was only an user, not the maintainer. It was integrated with pretty much everything else FB uses internally.

Re: Ask HN: Which Wiki or internal documentation tools do you use?

#70
I noticed here that noone seems to have mentioned using a static site generator for this.

We are currently evaluating tools for this with much of the same requirements.

My current idea for this is to use Hugo with https://themes.gohugo.io/hugo-theme-learn/ as the theme. It has search, code snippets and such. Does anyone have experience with doing it this way?

Post reply on HN