byte-motion / byte-motion/RNL_RAPIDLibrary

Suguest using github as platform for storing internal tehcnical notes, guides and how-to's

Open
#59 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
AMPL
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Project department meeting 2021-01-13, a question of where it would be most practicable to host manuals and experiences noted by technical personnel for other technical personnel.

is GitHub a good candidate for this?

- Easy -Github enforces easy to read and easy to edit markdown text format, as well as support for pictures (see the machine safety repo)

- Available -Most (all?) technical personnel will have access to GitHub.

- Accessible -Github can be accessed via app, web, and desktop application, while files on a server must be accessed with VPN and Microsoft word

- Flexible -Github facilitates naturally technical personnel to suggest changes based on their experiences, allowing notes and guides to evolve.

- Standard - Github is a standard that is being enforced on programming and safety already, pushing more documentation into github would give synergy.

The alternative of using Microsoft word documents, and uneditable PDF documents located serverside and not in the cloud seems to me unnecessarily old fasioned.

would like to hear your opinions!
@AndreBertheussen
@RobotSigmund
@Gyxoz

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.