this post was submitted on 17 Jun 2023
15 points (100.0% liked)

Sysadmin

5434 readers
1 users here now

A community dedicated to the profession of IT Systems Administration

founded 5 years ago
MODERATORS
 

Hi, all!

For those of you who work in organizations that do decent documentation, what are you using?

We currently just have a bunch of word docs in a SharePoint document library. I've previously used dedicated solutions for this such as Bookstack and Confluence. The company is very anti-Atlassian, so Confluence is out.

Just want to see what y'all are using as I search for a better solution.

Thanks!

top 27 comments
sorted by: hot top controversial new old
[–] [email protected] 2 points 1 year ago* (last edited 1 year ago)

Matterport tours. This is by far one of the best decisions we have made. We have notes, photos, documents, all linked in a 3D space of the site. We also use photogrammetry generated from drone footage for some of the larger exterior spaces and our wireless runs.

If we are on the phone with a client we usually pull the tour up in one window and the text notes up in another and we can walk them through anything. We also do cameras so I often link the cameras in the tour so we can just click and have Realtime interactions and see what the issue is.

[–] [email protected] 2 points 1 year ago (1 children)

We use WikiJs for documentation and user guides

[–] [email protected] 3 points 1 year ago (1 children)

I recently spun up an instance of Wikijs at work and have been loving it.

[–] [email protected] 1 points 1 year ago

I had to get used to it a little bit but I love it now as well. Especially nice thing is that you can connect it to a ldap server for accounts :)

[–] [email protected] 2 points 1 year ago (1 children)

I recently migrated all our various Excel and Word documents from Sharepoint into a self-hosted Bookstack instance. I love it.

I have one shelf for stuff like SOP, contracts, etc, and another for customer documentation.

[–] [email protected] 1 points 1 year ago

Thanks for sharing! I'm very tempted to give Bookstack a go.

[–] polystruct 1 points 1 year ago (1 children)

Currently Confluence. We do have a split documentation policy, where long-lived and broadly communicated information should be on M365 (SharePoint and affiliated services) whereas more technical or short-lived (project) documentation is on Confluence.

But even certain broad-use information is showing up on Confluence more and more given it's easier use (wiki and plugins like the draw.io support).

[–] [email protected] 1 points 1 year ago

Cool, thanks for sharing! Yeah I think it would be hard to convince anyone to use anything but SharePoint but I'm just formating options. Definitely want as little friction but with decent structure as possible to encourage active use of it.

[–] Couldbealeotard 1 points 1 year ago (1 children)

Documents, procedures, and manuals in Dropbox. Notes, reports, and to do lists in OneNote

[–] [email protected] 1 points 1 year ago

Thanks for sharing!

[–] [email protected] 1 points 1 year ago (1 children)

You could have them take s look at XWiki - Tomcat-based, very Confluence-like, open source.

[–] [email protected] 1 points 1 year ago

I will take a peek at this, thank you!

[–] [email protected] 1 points 1 year ago

What are you using for bug tracking? IMO, the two should be hand in hand. If you're using GitHub issues, then GitHub wiki would make sense to me.

I've never had good luck using SharePoint or Google Docs for documentation, it just gets lost. If you're searching GitHub for an issue, it's easy to expand the search to include wiki. Having documentation in a separate system means searching two places, which is not ideal.

[–] [email protected] 1 points 1 year ago (3 children)

Not using it, but Bookstack looked real nice for a documentation site.

We're using a different wiki at the moment for it.

[–] [email protected] 2 points 1 year ago

I had Bookstack at a previous org and really liked it, just nobody cared about it.

[–] [email protected] 1 points 1 year ago

We’ve been migrating a lot of documentation into Bookstack this year, and like it a lot so far.

[–] [email protected] 1 points 1 year ago

I setup bookstack at my last job and personally loved it. But yeah, takes a lot to get everyone on board with something like that. I liked that you could export stuff out of it easily too. Bridges the gap if you need to email documentation.

[–] [email protected] 1 points 1 year ago

For technical documentation, most of our teams are currently using Gitlab pages, however we are steadily moving to Backstage

[–] [email protected] 1 points 1 year ago

Dokuwiki instance

[–] rolaulten 1 points 1 year ago (1 children)

We use outline. Its a small startup with a solid product, and the devs are super responsive.

[–] [email protected] 1 points 1 year ago

This looks pretty interesting! Will definitely check it out, thanks.

[–] axzxc1236 1 points 1 year ago* (last edited 1 year ago) (1 children)

Where I work we are hosting onlyoffice and integrate it with nextcloud.

[–] [email protected] 1 points 1 year ago

Thanks for sharing!

[–] [email protected] 1 points 11 months ago (1 children)

Documentation? What's that?

[–] [email protected] 1 points 11 months ago

Haha that would be most the people on our team's response for sure.

[–] [email protected] 0 points 1 year ago (1 children)

ITGlue has been working out well for us.

[–] [email protected] 1 points 1 year ago

I love the look of ITGlue and one member of our team used it at several other orgs and loved it. It just seems pretty overkill with all the features since we have other platforms that handle the passwords/secrets/assets/etc. I do like the look of it though, and am considering it.

load more comments
view more: next ›