Ask HN: How does your team handle knowledge documentation?

Post by Ninjaneered » Sat, Nov 11, 2017, 12:31 AM UTC

bastijn wrote: post #50

ifoundthetao wrote: post #12

I have had great success with Mediawiki and Slate. With Mediawiki, you can use Categories, ex: [[Category:NameHere]], and templates (don't forget to update the CSS) for great organization and consistency. The usage of templates will allow you to be DRY, so if you update the template, where it is embedded will update too. And Slate was just a pleasure to work with.

FWIW we are moving out of MediaWiki after 10 years. The search function is horrible and the readability on any devices is not great either (understatement). The latter is with our theme, not sure if you can theme properly. Long sentences, no proper image positioning and scaling, mobile support is lacking, etc. Also versioning is a problem when you need both versions of the page to be readable (e.g. 1.0 and 1.1). It i…

Post by xaedes » Thu, Nov 16, 2017, 7:41 PM UTC

bastijn wrote: post #88

xaedes wrote: post #85

Earlier quoted context omitted.

Do you mind to share what kind of X in “how to properly document X” pages you have? I like that idea and would like to do similar!

I wouldn’t mind but our bureaucracy organ does :(. Whilst technically it is only moving the markdown files and CIconfig from our private gitlab to a public one, the bureaucracy involved with it prevents me from doing it today. I would have to pull a part of our source code which is under strict regulation, and I try to only start that process when I absolutely must do so (subsidiary projects mostly). The contents are…

  Thank you.