Skip to content

Latest commit

 

History

History
16 lines (8 loc) · 536 Bytes

README.md

File metadata and controls

16 lines (8 loc) · 536 Bytes

Documentation Beginners' Guide

What's the Goal of the Guide?

This guide is meant as an introduction for people who are not yet familiar with documentation, but want to start right away.

What's documentation?

It is the fine art of structuring a project by detailing every aspect of it, so that new people can quickly engage with your project.

What do I need to know before I start?

  • Basic Python programming to install some dependencies and tools.
  • Most importantly, have a project to have fun with.