digital-dream-labs / DDL-KB-Kanban

A public kanban of my current documentation projects for Digital Dream Labs.
6 stars 2 forks source link

Consolidate Documentation #25

Open xanathon opened 3 years ago

xanathon commented 3 years ago

Vector technical documentation is highly fragmented all over the internet. It is in the user-unfriendly and badly navigatable DDL knowledgebase (https://support.digitaldreamlabs.com) , it is in another knowledgebase for OSKR docs (https://oskr.ddl.io) and it spread over mutliple Github repositories. It is spread over multiple threads in Discord where you never find anything again because Discord is for chatting nor for group work.

This - as I said - is highly user-unfriendly and I have no idea why this is spread over so many places instead of being consolidated in one place. From the outside this looks highly unorganised without good project management to keep things together. From the looks there is a new means of documentation started for every subproject instead of using one wholesome solution.

This needs to be consolidated in one place with a user-friendly navigation that actually makes sense (other than the official knowledge base that does not even allow working siebar navigation).

There are multiple options to do this: An official wiki where people can contribute id one possibility, but Wikis tend to be not user-friendly when it comes to navigation and usage. Github is not usable for less tech-knowledgeable people that still could contribute docs and the generated docs are usually not user-friendly. There are other option, for example the open source cms Grav that is used in a lot of documentation projects. It would even be possible to pull documentation from e.g. Github into a single place.

At the moment multiple user projects are fragmented all over the internet. DDL needs to offer these projects a central hub so they can be found easily. That does not mean all external projects have to migrate to a central DDL site, but on said centeal site there could be a catalog of external projects with links, but it is also possible to encourage third parties to contribute to a central knowledge base.