Pivity

Poll: Documentation Methods?

Last read Never
#1

So I had documentation at some point just using a website, however, I didn't have any time at all to code a back-end system, so I was editing hard-coded text within a template I had made, and really just became a pain in the rear. I want to port all of my documentation for my scripts over; so the question is: What options do people use?

So far I've seen:

  1. PDF included
  2. MediaWiki
  3. Steam Guides

At one point, I tried Steam Guides, but you have ZERO control over commenting or banning people from viewing it. I had a guy spamming my comments with "PAID MODS SUCK RAWR XDXDXD" and everytime I deleted it, he'd just re-post. I don't like not having that type of control to get rid of some idiot.

I thought about the MediaWiki one, but I don't have a lot of experience with markup or doing the template for it (very limited on time because of other projects). So, ideas, suggestions?

Ideally, I'd just do a wiki, with steam login, and a way to check purchases, but then comes my original issue, I have zero time to invest in coding the system. I may need to hire someone with experience if that's the route I choose to go. My days are full enough, don't need one more project.

#2

Hmm what's the problem with having public docs? I personally use Sphinx on ReadTheDocs but it's also not ideal. Good thing is you can render it as pdf to ship with the script.

Agree x 1
#3

If I were to use a documention that wasn't an online wiki i'd prefer a PDF file over everything else. I don't see anything wrong with public documentation though.

#4
ByKamshakat 13th of July 2017 20:04:04
Hmm what's the problem with having public docs? I personally use Sphinx on ReadTheDocs but it's also not ideal. Good thing is you can render it as pdf to ship with the script.

I hadn't checked into ReadTheDocs yet, I'll poke a look at it. Seems simple enough. Thanks!

#5

If you want spambots, just use mediawiki

Dumb x 2
#6

We'll ship gmodstore v3812381883 with knowledgebases for each addon btw

Agree x 2Winner x 1
#7

force billy to finish his document platform

Agree x 1
#8
ByLunaversity.xyz 🌸at 13th of July 2017 22:23:45
force billy to finish his document platform

see below

ByMarcuzat 13th of July 2017 22:20:01
We'll ship gmodstore v3812381883 with knowledgebases for each addon btw


ByLapinat 13th of July 2017 21:02:27
If you want spambots, just use mediawiki

If you don't want spambots, just turn off public contribution.....

#9
ByMarcuzat 13th of July 2017 22:20:01
We'll ship gmodstore v3812381883 with knowledgebases for each addon btw

ETA: Never

But on topic I would rather have PDFs

Dumb x 1
#10
ByAnthony Fullerat 14th of July 2017 14:44:36
But on topic I would rather have PDFs

Include them with the files for your script??????

Users viewing this thread
Nobody