What are you using for Documentation?
-
I've been tasked with finding the best solution for IT documentation that I can. We have Sharepoint but we are doing very little documentation out of it currently. I know a lot of you are using wiki's. The idea is that I spin up a ton of different options, test them and then present a few to my CIO. Any recommendations are appreciated.
-
-
@coliver said in What are you using for Documentation?:
Sharepoint could work as well as it has a built in wiki but it's a huge amount of infrastructure for something so simple.
Yeah it seems that way
-
Here's another recommendation for BookStack.
-
Using wiki.js
-
Wiki.js runs on pretty much any platform that supports the requirements below. However, the following environments are recommended and more thoroughly tested:
- Ubuntu Server 16.04 LTS
- Windows Server 2012 R2
Those are both pretty old.
-
I use Grav
-
I like both bookstack and wiki.js. If it was just me and a few other technical people creating organizing the content, then I would use wiki.JS. For something that is more what you see is what you get, I would use bookstack.
-
Has any of this stuff been fixed?
https://mangolassi.it/topic/16307/i-hope-wiki-js-does-not-fail
https://mangolassi.it/topic/16033/wiki-js-not-saving-colors
https://mangolassi.it/topic/16245/wiki-js-editing-works-poorly-on-ios -
I'm not sure I understand the justification for not using Sharepoint. It would be a lot of infrastructure to spin up something fresh. If you have it already because of something else (O365 or a different project) what is the justification for not using it. Documentation doesn't need much. Spinning up a dedicated Sharepoint subsite would be trivial, and assuming that you've built out your permissions and groups already would save you a ton of time setting it up. You don't have to deal with another VM, patches, version conflicts, etc. There are probably things that do it better, if only slightly, but does that minimal (in my perspective) improvement justify the effort?
-
@kelly said in What are you using for Documentation?:
I'm not sure I understand the justification for not using Sharepoint. It would be a lot of infrastructure to spin up something fresh. If you have it already because of something else (O365 or a different project) what is the justification for not using it. Documentation doesn't need much. Spinning up a dedicated Sharepoint subsite would be trivial, and assuming that you've built out your permissions and groups already would save you a ton of time setting it up. You don't have to deal with another VM, patches, version conflicts, etc. There are probably things that do it better, if only slightly, but does that minimal (in my perspective) improvement justify the effort?
I'm honestly not sure what we have built out. From what I've seen so far (limited) sharepoint seems unnecessary for what we would want to do with it. It can even be cumbersome but that may be because of how we are using it.
-
@aaronstuder said in What are you using for Documentation?:
Has any of this stuff been fixed?
https://mangolassi.it/topic/16307/i-hope-wiki-js-does-not-fail
https://mangolassi.it/topic/16033/wiki-js-not-saving-colors
https://mangolassi.it/topic/16245/wiki-js-editing-works-poorly-on-iosProbably with with version 2.0
-
Confluence is a pretty good solution. You can have it hosted or self-host. Cost is minimal for up to 10 users. Has a rich feature set including individual permissions, exporting to PDF and Word, creating templates, easy attachment, and image handling, etc.
-
@wirestyle22 said in What are you using for Documentation?:
@kelly said in What are you using for Documentation?:
I'm not sure I understand the justification for not using Sharepoint. It would be a lot of infrastructure to spin up something fresh. If you have it already because of something else (O365 or a different project) what is the justification for not using it. Documentation doesn't need much. Spinning up a dedicated Sharepoint subsite would be trivial, and assuming that you've built out your permissions and groups already would save you a ton of time setting it up. You don't have to deal with another VM, patches, version conflicts, etc. There are probably things that do it better, if only slightly, but does that minimal (in my perspective) improvement justify the effort?
I'm honestly not sure what we have built out. From what I've seen so far (limited) sharepoint seems unnecessary for what we would want to do with it. It can even be cumbersome but that may be because of how we are using it.
I'd recommend creating a test subsite that is dedicated to what you want rather than adapting the default site. The enterprise wiki webpart does take a little bit to enable - https://www.admin-enclave.com/en/articles/sharepoint/412-howto-create-an-enterprise-wiki-on-sharepoint-online.html, but it would probably do what you need it to.
-
I'd say start with what services you already have; do you have Office365?
If so start with that, and then look at other options before adding more components to your system.
-
Last place was Asciidoctor and GitLab but testing Asciidoctor and Hugo. New place is currently Asciidoctor to PDF but will be testing Hugo and other options.
-
I use Teams, OneNote and Sharepoint. Documentation in OneNote, then mange them via Teams, which creates the relevant Sharepoint sites in the background.
I like Teams, it takes a lot of the burden out of managing Sharepoint.
What kind and quantity of documentation are you looking at?
-
I use Google Docs, and the ticketing system ; Im the only one who does write ups on things I think we need to know more about, or are things that will be needed in the future.
I/We don't use any fancy third party software for documentation.
-
I use OneNote at work and MediaWiki at home. However I like Bookstack for some things, Boostnote for my C++ documentation, and Wiki.js is good all round and not so specific.
-
@carnival-boy said in What are you using for Documentation?:
What kind and quantity of documentation are you looking at?
I have to guess an absolute shit ton. I haven't seen the magnitude yet
