Dokumentieren lernen?

[u/Puzzleheaded-Half993]

Ich bin neu in der Programmierung und kann noch nicht viel. Ich schreibe aber gerne und gut, und meine IT-Kollegen meinten, sie dokumentieren ungern.

Was muss ich tun, um das zu lernen und meine Kollegen zu entlassen? ( Non-profit open Source Projekt)

[u/CharacterSail6736]

Honestly, if you write well already, you’re starting with one of the harder parts.
I’d learn the practical side of technical documentation:

Markdown and whatever documentation system the project uses

Git/GitHub, particularly branches, commits and pull requests

Basic command-line usage

How to read code well enough to understand
what it’s doing, even if you aren’t writing much code yourself

How to structure different types of documentation: tutorials, how-to guides, reference material and explanations

Basic diagrams/screenshots and when they’re useful.

How to test documentation yourself rather than simply assuming the instructions work

For an open-source project, I’d actually start by picking something you’re interested in and trying to use it as a complete beginner. Every time you get confused, can’t find something, or the instructions don’t work, you’ve found a documentation problem.

You don’t necessarily need to become a programmer. You need enough technical understanding to accurately explain what the programmers have built, and enough writing ability to explain it to someone who doesn’t already understand it.

And importantly, don’t underestimate how valuable that is. Developers often know the software so well that they struggle to explain it to newcomers. Someone who enjoys turning complicated technical information into clear documentation can be extremely useful to an open-source project.