What are you using for Documentation?
-
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
-
@wrcombs said in What are you using for Documentation?:
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.
We have infrastructure (Me), DevOps, Desktop Support. I think one person from each team should be responsible for technical documentation. I'd prefer for it to be me but I also have a lot on my plate.
-
I think one important consideration is moving from one solution to another and how difficult/cumbersome that can be. How annoying would Sharepoint be in this regard? say I move from Sharepoint to Bookstack
-
@wirestyle22 said in What are you using for Documentation?:
I think one important consideration is moving from one solution to another and how difficult/cumbersome that can be. How annoying would Sharepoint be in this regard? say I move from Sharepoint to Bookstack
I don't know how Bookstack handles things now, but much of what is stored on Sharepoint is either table based (exportable via Excel), or just HTML. Most. I don't have a SP instance to fiddle with any more, so I can't say definitively.
-
@wirestyle22 said in What are you using for Documentation?:
I think one important consideration is moving from one solution to another and how difficult/cumbersome that can be. How annoying would Sharepoint be in this regard? say I move from Sharepoint to Bookstack
SP depends. If you use their straight wiki functions, not bad. If you use OneNote, terrible.
-
I'm trying to stay away from big software packages that do everything in one. I don't want to have to keep something just because we use it for other things. I like separating everything so I can remove what I don't like and keep what I do. I don't know a lot about Sharepoint yet but that is why I am wary.
-
@wirestyle22 said in What are you using for Documentation?:
@wrcombs said in What are you using for Documentation?:
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.
We have infrastructure (Me), DevOps, Desktop Support. I think one person from each team should be responsible for technical documentation. I'd prefer for it to be me but I also have a lot on my plate.
I do write up and document everything so I can learn and help someone else out. these guys just do it and move on...
-
@wirestyle22 said in What are you using for Documentation?:
@wrcombs said in What are you using for Documentation?:
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.
We have infrastructure (Me), DevOps, Desktop Support. I think one person from each team should be responsible for technical documentation. I'd prefer for it to be me but I also have a lot on my plate.
How do you separate infrastructure and DevOps? DevOps is for managing infrastructure.
-
I use WordPress.
Here's a demo:
https://tgserv.timothygruber.com/wpwikiHere's how to set it up:
https://timothygruber.com/web/creating-modern-wiki-wordpress/ -
-
MarkdownViewerPlusPlus.dll
-
@scottalanmiller said in What are you using for Documentation?:
@wirestyle22 said in What are you using for Documentation?:
@wrcombs said in What are you using for Documentation?:
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.
We have infrastructure (Me), DevOps, Desktop Support. I think one person from each team should be responsible for technical documentation. I'd prefer for it to be me but I also have a lot on my plate.
How do you separate infrastructure and DevOps? DevOps is for managing infrastructure.
Infrastructure team is really networking team
-
@wirestyle22 said in What are you using for Documentation?:
@scottalanmiller said in What are you using for Documentation?:
@wirestyle22 said in What are you using for Documentation?:
@wrcombs said in What are you using for Documentation?:
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.
We have infrastructure (Me), DevOps, Desktop Support. I think one person from each team should be responsible for technical documentation. I'd prefer for it to be me but I also have a lot on my plate.
How do you separate infrastructure and DevOps? DevOps is for managing infrastructure.
Infrastructure team is really networking team
Infrastructure teams normally refers to the non-networking ones. Although networking is obviously infrastructure. But SA is normally core infrastructure teams. Enterprise jobs labeled infrastructure are not networking.
