How and where to store technical documentation?

Question

Documentation

I put the infrastructure in the Company in order and it was time for documentation. How to store and where?

Answer 1

DokuWiki

Answer 2

A good approach is docs as code.
We maintain all documents in git repositories, in Markdown format . The sources are wrapped in Foliant , which can assemble PDF, docx, website, google doc or anything from md at any time. For example, many projects with documentation are automatically collected into a knowledge base using GitLab-CI . With each push of changes to the repository, the site is rebuilt and we are sure that there are always fresh docks. And as soon as the manager asks for a finished document, you can immediately assemble a PDF, with a corporate logo, etc.
At the same time, the sources are always in plain-text in the repositories, which makes it possible to work on the docks together or three, with all the adult features like development and master of branches, features, releases, as if it were code.

Answer 3

Knowlage base - space in corp. Confluence
Infrastructure, cable documentation and description of switch servers - Racktables.

Answer 4

If you don’t want to point your finger at the sky, but you need a systematic approach without fakups, start studying the topic here: What is the best way to make company documentation? and follow the links in that post.
PS Repeatedly notice an interesting fact. Everyone advises a solution that they seem to have heard of or that works specifically for them, but no one asks the main question: what is the purpose of the TS? What are the input conditions for the TS? Thread participants, you understand that the choice of an instrument/approach is not a choice from A, B, C. This is, first of all, the definition of a goal (they can differ by 180 degrees), analysis of the input conditions, and only then the choice of an instrument/approach . If a particular participant of this topic has a tool/approach that benefits him, then this does NOT mean at all that the same approach will necessarily work for a topic starter with the same success.

Answer 5

my evolution:
1 bunch txt
2 redmine
3 confluence

Answer 6

xwiki
https://www.xwiki.org/xwiki/bin/view/Main/WebHome

Answer 7

docsify + gist.github.com

Answer 8

There are a lot of people posting specific solutions here.
And I advise any WIKI. Whatever you like. Now you will not understand the delights of collaboration and other things that will give you a more serious product.
And so - there are branches, connectivity without problems, versioning again. Collaboration, comments - yes, all this is in any wiki engine I know

Answer 9

confluence

Answer 10

Docks in any Wiki.
Config files in Git (and analogues), you can rollback, etc., everything is at hand, you can see when something changed.
The scheme can be in the banal Visio.
Previously, I kept info on computers and printers in a bunch of GLPI + FussionInventory, by the way, there was also a FAQ base

Answer 11

redmine. It has both a document repository and a wiki. Diagrams in Visio. Configs and other text canoe - in SVN

Answer 12

zoo doc files on ftp
crying and sobbing
wrote just to complain.

Answer 13

Confluence, Netbox

Answer 14

Any Wiki + fundamental things in paper is a must (executive documentation and other plans and schemes, for example)

Answer 15

Sphinx + readthedocs + git theme + sometimes plantuml integration are great for documenting sources, apis, software products, web interfaces, algorithms, and just plain text. De facto standard for IT, very convenient and beautiful

Answer 16

www.fotololo.ru/blog/sdelay-sobstvennuyu-3d-kameru
and here
https://www.cambridgeincolour.com/ru/tutorials-ru/...