Technical Documentation
-
@aaronstuder said:
What do you use? I am thinking about using Confluence but I wanted to see what you guys are using first
We use Confluence here but campus wide. If I were doing it for IT I would looking into dokuWiki or Mediawiki.
-
I'm really pushing a few departments to start making their own documentation.
Currently they create word files and have a master word document with links to the other ones. Of course this would be infinitely better on a website than a word document.
I think I'll stand up another media wiki.
@coliver would you do a turnkey or on top of Ubuntu or CentOS? and why?
-
Actually, if I was already invested in O365 I would roll Sharepoint and use the for documentation.
It is so easy to install doku or mediawiki that I don't think I would go turnkey.
-
@coliver said:
It is so easy to install doku or mediawiki that I don't think I would go turnkey.
Which one would you use? or What would you be leaning towards?
This is for public docs, and private docs so I need some control over who can see what.
-
A wiki does seem much simpler
-
@aaronstuder said:
A wiki does seem much simpler
But formatting sucks!
-
@aaronstuder said:
@coliver said:
It is so easy to install doku or mediawiki that I don't think I would go turnkey.
Which one would you use? or What would you be leaning towards?
This is for public docs, and private docs so I need some control over who can see what.
I've only ever stood up a MediaWIki server. Dokuwiki looks to be easier to implement. Both can do authentication and authorization. So you wouldn't have any issues locking down certain areas.
-
@Dashrender said:
@aaronstuder said:
A wiki does seem much simpler
But formatting sucks!
Really? I've never noticed an issue with formatting. Mediawiki has some plugins that have better WYSIWYG editors but the default one and the syntax are pretty quick the learn.
-
@coliver said:
@Dashrender said:
@aaronstuder said:
A wiki does seem much simpler
But formatting sucks!
Really? I've never noticed an issue with formatting. Mediawiki has some plugins that have better WYSIWYG editors but the default one and the syntax are pretty quick the learn.
having to type '<br>' everywhere to get a carriage return is a huge PITA.
-
Confluence is nice. The editor is easy to use they do have a strange permissions system that doesn't always work the greatest, but there is a huge overhead in both resources and licensing when you compare to other options.
-
@Dashrender said:
@coliver said:
@Dashrender said:
@aaronstuder said:
A wiki does seem much simpler
But formatting sucks!
Really? I've never noticed an issue with formatting. Mediawiki has some plugins that have better WYSIWYG editors but the default one and the syntax are pretty quick the learn.
having to type '<br>' everywhere to get a carriage return is a huge PITA.
In Mediawiki? Just hit return twice.
-
I'll stand one up tonight or tomorrow..
try again. -
http://www.wikimatrix.org/compare/dokuwiki+mediawiki
duku seems like the clear winner here...
-
@Dashrender said:
I'll stand one up tonight or tomorrow..
try again. -
@coliver said:
@Dashrender said:
I'll stand one up tonight or tomorrow..
try again.Can you limit access to this?
-
@wirestyle22 said:
@coliver said:
@Dashrender said:
I'll stand one up tonight or tomorrow..
try again.Can you limit access to this?
I'm not sure what you mean?
-
@coliver said:
@wirestyle22 said:
@coliver said:
@Dashrender said:
I'll stand one up tonight or tomorrow..
try again.Can you limit access to this?
I'm not sure what you mean?
It's a website correct? What if your documentation are instructions and have sensitive information like IP addresses for remote access etc? I would need to limit access.
-
@wirestyle22 said:
@coliver said:
@wirestyle22 said:
@coliver said:
@Dashrender said:
I'll stand one up tonight or tomorrow..
try again.Can you limit access to this?
I'm not sure what you mean?
It's a website correct? What if your documentation are instructions and have sensitive information like IP addresses for remote access etc?
Both MediaWiki and DokuWiki can require authentication for some pages and other pages be completely public.
-
@coliver said:
@wirestyle22 said:
@coliver said:
@wirestyle22 said:
@coliver said:
@Dashrender said:
I'll stand one up tonight or tomorrow..
try again.Can you limit access to this?
I'm not sure what you mean?
It's a website correct? What if your documentation are instructions and have sensitive information like IP addresses for remote access etc?
Both MediaWiki and DokuWiki can require authentication for some pages and other pages be completely public.
That is fantastic. Thank you very much for the recommendation. Very helpful.
-
The nice thing about dokuwiki is that it uses just text files. No backend database or anything like that.